DRM Manual

198
ORACLE® HYPERION DATA RELATIONSHIP MANAGEMENT, FUSION EDITION RELEASE 11.1.1.1 N-TIER USER’S GUIDE

description

this drm

Transcript of DRM Manual

Page 1: DRM Manual

O R A C L E ® H Y P E R I O N D A T A R E L A T I O N S H I PM A N A G E M E N T , F U S I O N E D I T I O N

R E L E A S E 1 1 . 1 . 1 . 1

N - T I E R U S E R ’ S G U I D E

Page 2: DRM Manual

Data Relationship Management N-tier User’s Guide, 11.1.1.1

Copyright © 1999, 2008, Oracle and/or its affiliates. All rights reserved.

Authors: EPM Information Development Team

This software and related documentation are provided under a license agreement containing restrictions on use anddisclosure and are protected by intellectual property laws. Except as expressly permitted in your license agreement orallowed by law, you may not use, copy, reproduce, translate, broadcast, modify, license, transmit, distribute, exhibit,perform, publish or display any part, in any form, or by any means. Reverse engineering, disassembly, or decompilationof this software, unless required by law for interoperability, is prohibited.

The information contained herein is subject to change without notice and is not warranted to be error-free. If you findany errors, please report them to us in writing.

If this software or related documentation is delivered to the U.S. Government or anyone licensing it on behalf of the U.S.Government, the following notice is applicable: U.S. GOVERNMENT RIGHTS: Programs, software, databases, and relateddocumentation and technical data delivered to U.S. Government customers are "commercial computer software" or"commercial technical data" pursuant to the applicable Federal Acquisition Regulation and agency-specific supplementalregulations. As such, the use, duplication, disclosure, modification, and adaptation shall be subject to the restrictions andlicense terms set forth in the applicable Government contract, and, to the extent applicable by the terms of the Governmentcontract, the additional rights set forth in FAR 52.227-19, Commercial Computer Software License (December 2007).Oracle USA, Inc., 500 Oracle Parkway, Redwood City, CA 94065.

This software is developed for general use in a variety of information management applications. It is not developed orintended for use in any inherently dangerous applications, including applications which may create a risk of personalinjury. If you use this software in dangerous applications, then you shall be responsible to take all appropriate fail-safe,backup, redundancy and other measures to ensure the safe use of this software. Oracle Corporation and its affiliates disclaimany liability for any damages caused by use of this software in dangerous applications.

This software and documentation may provide access to or information on content, products and services from thirdparties. Oracle Corporation and its affiliates are not responsible for and expressly disclaim all warranties of any kind withrespect to third party content, products and services. Oracle Corporation and its affiliates will not be responsible for anyloss, costs, or damages incurred due to your access to or use of third party content, products or services.

Page 3: DRM Manual

Contents

Documentation Accessibility . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9

Chapter 1. About Data Relationship Management . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11

Features . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11

Key Features . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11

Hierarchical Data Management Types . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13

System Architecture . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13

Data Relationship Management Components . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14

Applications . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14

Versions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14

Hierarchies . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15

Nodes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15

Referential Integrity . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 16

Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 16

Inheritance . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17

Validations and Verifications . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17

Imports . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 18

Automator . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 18

Blender . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 18

Exports . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 19

Property Queries . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 19

Compare . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 19

Data Relationship Management Typical Data Life Cycle . . . . . . . . . . . . . . . . . . . . . . . . . 20

Chapter 2. Getting Started . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 23

Starting Data Relationship Management . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 23

Creating Login Connections . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24

Changing Passwords . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 25

Data Relationship Management Desktop and Menus . . . . . . . . . . . . . . . . . . . . . . . . . . . . 25

Speed Buttons . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 26

Main Menu Commands . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 26

Action Menus . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 29

Contents iii

Page 4: DRM Manual

Hot Keys . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 29

Using the Options Dialog Box . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 29

Naming Metadata Objects . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 32

Chapter 3. Using Versions, Hierarchies, Nodes, and Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 33

Working with Versions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 33

Version Control Window . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 33

Creating As Of Versions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 36

Using the Version Criteria Dialog Box . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 38

Working with Hierarchies and Nodes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 38

Using Shared Nodes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 39

Opening Hierarchies and Nodes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 41

Hierarchy Window . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 42

Navigating Hierarchies . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 45

Adding and Inserting Nodes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 45

Next ID Function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 47

Model After . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 48

Moving Nodes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 50

Using Node Deletion Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 52

Orphan Nodes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 54

Merging Nodes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 55

Finding Nodes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 56

Sorting Nodes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 57

Node Security . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 58

Working with Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 58

Using the Property Editor . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 58

Version and Hierarchy Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 65

Security . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 66

Administrator Types . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 66

User Assignment to Property Categories . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 67

User Assignment to Node Access Groups . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 67

Chapter 4. Running Imports . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 69

Import Elements . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 69

Import Sections . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 70

Starting the Import Wizard . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 70

Naming Import Versions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 71

Configuring Section and Processing Options . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 72

Configuring Mappings . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 74

Specifying File Format Information . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 75

iv Contents

Page 5: DRM Manual

Configuring Duplicate Handling . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 78

Viewing Import Results . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 80

Chapter 5. Using Automator . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 83

Performing Automator Imports . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 83

Running Automator . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 84

Reviewing Automator Processing Errors . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 86

Automator File Format . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 86

Supported Automator Actions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 87

Required Automator Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 89

Chapter 6. Using Blender . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 93

Blender Elements . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 93

Using the Blender Wizard . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 94

Configuring Blender Versions and Hierarchies . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 95

Configuring Top Nodes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 98

Viewing Blender Results . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 102

Chapter 7. Running Exports . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 105

Export Classes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 105

Starting the Export Wizard . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 106

Top Nodes Page . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 107

Select Columns Page . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 109

Column Options Page . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 112

Column Widths Page . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 113

Parameter Pages . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 113

Generation Export Parameters Page . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 114

Hierarchy Compare Export Parameters Page . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 116

Hierarchy Difference Report Parameters Page . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 117

Hierarchy Export Parameters Page . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 118

Lookup Export Parameters Page . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 120

Property List Export Parameters Page . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 121

Merge Log Export Parameters Page . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 121

Transaction Log Export Parameters Page . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 122

Version Export Parameters Page . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 123

Ancestor Export Parameters Page . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 123

Verification and Filter Page . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 124

Exclusion Filter Page . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 125

Output Formatting Page . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 126

Output Destination Page . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 128

Contents v

Page 6: DRM Manual

Using Export Books . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 133

Chapter 8. Using Verifications and Validations . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 137

Validations . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 137

Verifications . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 137

Validation or Verification . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 137

Validation Characteristics . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 138

Validation and Verification Assignment . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 138

Running Validations . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 138

Running Verifications . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 138

Viewing Verification Results . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 140

Chapter 9. Running Property Queries . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 141

Working with Property Queries . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 141

Property Query Types . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 142

Performing Queries . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 142

Property Query Options . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 146

Hot Lists . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 148

Chapter 10. Comparing Hierarchies . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 151

Hierarchy Compare Types . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 151

Standard Compare . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 151

Property Compare . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 151

Renamed Node Compare . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 152

Comparing Hierarchies . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 152

Chapter 11. Viewing Transaction History . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 157

Administrative Actions in Transaction History . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 157

Data Actions in Transaction History . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 159

Transaction History Range and Filter Specification . . . . . . . . . . . . . . . . . . . . . . . . . . . . 161

Transaction History Details . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 163

Chapter 12. Using the Data Relationship Management Batch Client . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 165

Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 165

Securing the Batch Client . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 166

Setting up Batch Client Credentials . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 166

Running the Batch Client . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 166

Dependencies . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 167

Saving Versions in the Batch Client . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 167

Command Line Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 167

Configuration File Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 172

vi Contents

Page 7: DRM Manual

Outputs and Result Codes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 178

Chapter 13. Using Data Relationship Management Web Publishing . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 181

Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 181

Web Server Commands . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 182

Using Web Client Features . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 183

Main Toolbar and Hierarchy Window . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 184

Selecting Versions and Hierarchies . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 184

Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 185

Exports . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 185

Print . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 187

Find . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 187

Frequently Asked Questions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 189

How do I display the home page after I install or update Data Relationship ManagementWeb Publishing? . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 189

How do I start the Data Relationship Management Web engine? . . . . . . . . . . . . . . . 190

How do I check for error messages? . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 190

How do I check for connectivity with the Data Relationship Management applicationserver? . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 190

Appendix A. Accessibility . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 191

Enabling Accessibility . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 191

Enabling Keyboard Equivalents . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 191

Index . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 195

Contents vii

Page 8: DRM Manual

viii Contents

Page 9: DRM Manual

Documentation Accessibility

Our goal is to make Oracle products, services, and supporting documentation accessible, withgood usability, to the disabled community. To that end, our documentation includes featuresthat make information available to users of assistive technology. This documentation is availablein HTML format, and contains markup to facilitate access by the disabled community.Accessibility standards will continue to evolve over time, and Oracle is actively engaged withother market-leading technology vendors to address technical obstacles so that ourdocumentation can be accessible to all of our customers. For more information, visit the OracleAccessibility Program Web site at http://www.oracle.com/accessibility/.

TTY Access to Oracle Support ServicesOracle provides dedicated Text Telephone (TTY) access to Oracle Support Services within theUnited States of America 24 hours a day, seven days a week. For TTY support, call 800.446.2398.

9

Page 10: DRM Manual

10 Documentation Accessibility

Page 11: DRM Manual

1About Data Relationship

Management

In This Chapter

Features... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .11

System Architecture ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .13

Data Relationship Management Components.. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .14

Data Relationship Management Typical Data Life Cycle .. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .20

FeaturesOracle Hyperion Data Relationship Management, Fusion Edition functions as a hub wherereporting structures are maintained, analyzed, and validated before moving throughout theenterprise.

Key FeaturesData Relationship Management does the following:

● Manages hierarchies, business rules, mappings, and validations

● Enforces referential integrity across all subscribing systems and hierarchies

● Enables users to create and manage alternate views

● Maintains historical versions for comparative reporting and analysis

● Tracks all hierarchy and attribute changes with a full-featured audit log

● Manages parallel hierarchies

● Can serve as the main point-of-entry to update subscribing systems or be used after-the-fact for reconciliation and analysis

Ease of UseAlthough Data Relationship Management is designed to manage and validate the most complexdimensional structures and their related metadata requirements, the interface provides anintuitive and familiar look and feel.

For each system or data set that the tool manages (through import or direct input), there is agraphical representation of the data. To validate this dimensional data, a metadata repositorycontains user-defined business rules, validation instructions, and relationship information. As

Features 11

Page 12: DRM Manual

the dimensional data changes in each participating system or within Data RelationshipManagement, data integrity issues are regulated, validated, and reported.

EfficiencyData Relationship Management is specifically designed to synchronize data across multiplesystems. All functionality in the tool is focused on adding efficiency to the hierarchical datamanagement process.

The implementation of Data Relationship Management involves a configuration process, asopposed to a custom development process. Configuration mitigates the inherent risks and testingcycles associated with custom programming.

After implementation, Data Relationship Management provides several data managementfeatures that support large-scale analysis and reconciliation of data.

Table 1 Efficiency Features

Feature Benefit

Versioning Multiple instances of data dimensions can be saved and used for historical reporting,comparisons, reconciliations, and what-if analyses

Business rule enforcement User-defined validations, ranging from simple data verification to organizational policies,can be applied across dimensions in a real-time or batch mode

Hierarchy debugging tools Tools that enable the user to analyze integrity issues across multiple data sets

FlexibilityTo support the changing needs of a dynamic business environment, Data RelationshipManagement provides an intuitive, graphical configuration utility. This utility, designed for thenon-technical user, enables immediate changes to Data Relationship Management functionalitywithout the need for custom programming.

SecurityThe security model of Data Relationship Management manages user access at the followinglevels:

● Versions—User access is restricted based on the version status

❍ A working version is accessible to all users based on their access

❍ A submitted version is editable only by system administrators and functionaladministrators.

❍ Finalized and expired versions are read only to all users and administrators.

● Hierarchy—User access can be restricted to certain areas within a hierarchy. For example,within the chart of accounts, a group of users may only need to maintain the Asset structure.If a user does not have access to a hierarchy, the hierarchy is not displayed. If a user doesnot have access to any hierarchies in a version, the version is not displayed.

12 About Data Relationship Management

Page 13: DRM Manual

● Property categories—User access can be restricted to certain property categories for aspecified node. In most cases, property categories are based on a system basis. For example,a user may be allowed to access the Essbase property category with read/write permissionand the Financial Management property category group with read-only permission. If a userdoes not have access to a property category, the tab does not display.

● Administrative and user types—Users can be grouped into four types:

❍ System Administrator — has full access including to metadata

❍ Functional Administrator — has full access to the hierarchy data but does not haveability to change metadata

❍ Security Administrator — can only create and assign logins

❍ Normal user — has access to only the information based on the node access groups towhich they are assigned and the property categories to which they are granted access

The configuration utility for Data Relationship Management supports user-defined validationsthat enforce integrity and policy issues. These business rules can be applied during the data entryprocess or routinely in a batch mode.

Hierarchical Data Management TypesTypes of hierarchical data managed by Data Relationship Management are:

● Organizational structures

● Charts of accounts

● Products

● Customer relationships

System ArchitectureThe Data Relationship Management N-tier application is based on an application-serverarchitecture. Use of an application-server architecture enables the bulk of the system processingto be performed on a centralized server and simplifies the client requirements for each end user.

The following diagram gives a top-level overview of the Data Relationship Management N-tierarchitecture. The Data Relationship Management client is a Windows application that runs onthe user’s local computer. The client connects to the Data Relationship Management applicationserver which can support multiple, simultaneous users. The Data Relationship Managementdatabase can be hosted on the application server machine or elsewhere.

System Architecture 13

Page 14: DRM Manual

Figure 1 N-tier Architecture

Data Relationship Management ComponentsThe following topics describe the main components and features of Data RelationshipManagement.

ApplicationsA Data Relationship Management installation can use multiple back-end databases to supportthe many business needs for hierarchical data within an organization. Each database is referredto as an application, and each application is independent from any other application. If you arein doubt about which application to use, see your system administrator.

VersionsData Relationship Management groups sets of hierarchies into versions. A version represents asingle, independent set of data arranged into related hierarchies. Versions are usually related totime periods or functions. Examples of versions are March 2001, 3rd Quarter 2000, and Planning.All Data Relationship Management maintenance is performed in versions; users cannot copy ormove nodes across versions. The only features that work across versions are compares and someexports.

Nodes and properties within a version are shared among the hierarchies within the version.Versions are typically used for the following purposes:

● To represent a set of hierarchies used during a particular month (or other business cycleperiod). Each month a version is created, maintaining an audit trail of hierarchies.

● To differentiate between real and test data during system testing.

● To compare different versions to identify changes made to the hierarchies within a timedimension.

14 About Data Relationship Management

Page 15: DRM Manual

You can create new versions by copying existing versions, but, after a version is created, it isindependent of other versions. Versions can be copied, created, and deleted by a systemadministrator.

Each version has an associated status.

Table 2 Status Descriptions

Status Description

Working Users can edit the hierarchies within the version

Submitted System administrators are performing final validations on the hierarchies. No further changes by otherusers are permitted

Finalized No changes are permitted. From the current version, all exports to other systems are performed.

Expired The hierarchies are now out-of-date. Data is maintained for historical purposes and as an audit trail

HierarchiesA hierarchy is a set of nodes that are all descendants of the same node. Thus, a hierarchy is definedby its top node and represents all nodes in the hierarchical relationships below that top node.

Hierarchies are contained within a version; and a version can contain multiple hierarchies.Hierarchies provide the main interface for a user when working with Data RelationshipManagement.

Each hierarchy is usually associated with a certain view, external system, or management report.Examples of hierarchies are Line of Business, Geographic, SAP - Legal, and ManagementSummary.

NodesA node is a point within a hierarchy. Every point in a hierarchy is a node. For example, withina hierarchy that represents an organizational structure, a node might represent a department ora cost center.

Within a version, a node may be a part of more than one hierarchy. A node can have many user-defined properties that store information about the node and control the use of the node withinthe information systems of an organization.

The following terms are used to define the position of a node and behavior of the node withina hierarchy:

Table 3 Node Terminology

Term Definition

Leaf A node that cannot have children

Limb A node that can have children

Data Relationship Management Components 15

Page 16: DRM Manual

Term Definition

Child A node directly below another node (if B is directly below A, B is a child of A)

Parent A node directly above another node (in the previous example, A is the parent of B)

Descendants All nodes below a specified node (including children and all children of children)

Ancestors All nodes between a node and the top of the hierarchy (including the parent, the parent of the parent,and so on)

Children All nodes directly below a node

Siblings All nodes that share a parent node in a particular hierarchy

Orphan A node not assigned to any hierarchy

Referential IntegrityReferential integrity (RI) is a concept normally associated with relational databases. In DataRelationship Management, RI means that no relational data violates established keys or domainranges. In this database context, RI refers to two core rules that the Data RelationshipManagement engine enforces while users are editing hierarchies:

● A node must have the same children in all hierarchies. Thus, a node always represents thesame rollup structure regardless of context.

● A node cannot exist more than once in a hierarchy. Thus avoiding any “circular reference”problems.

By enforcing RI, Data Relationship Management inhibits errors related to structure andredundancy that might occur during the maintenance process.

PropertiesProperties are data elements that are similar to fields in a database. Properties can be definedand stored at four levels:

● Version

● Hierarchy

● Global node - the value for the node is the same no matter what hierarchy it is in or whatparent it has

● Local node - the value for the node can be different for the node in different hierarchies

Most properties in Data Relationship Management are defined at the node level and containnode descriptions. Examples include the name of a node (called Abbrev in Data RelationshipManagement), the description for a node, and the number of children of a node. Properties atthe version and hierarchy level are less common. Examples include properties used for header-level information in Data Relationship Management exports.

16 About Data Relationship Management

Page 17: DRM Manual

The system administrator can define as many properties as needed. Data RelationshipManagement is delivered with two categories of standard properties:

● System properties that define a node

● Statistical properties that provide information about a node

InheritanceInheritance is a feature that enables high-level nodes to share their property values with lowerpoints in the hierarchy, eliminating the need to store and maintain redundant information. Itenables newly entered nodes to automatically obtain their property values from the appropriateancestors. Proper use of inheritance can greatly reduce data-entry requirements.

When defining a property, the system administrator can define the property as inheriting. Thisdefinition enables the values for the property to cascade down to its descendants.

Inheritance moves through a specific chain of events to determine the value for a property:

1. Data Relationship Management looks for a value entered at the current node. If a user hasdirectly entered a value at the node, the entered value is used.

2. If a value does not exist, Data Relationship Management searches the ancestors of the nodefor a value. The first entered value that Data Relationship Management finds, moving upthe hierarchy is used. Thus, a change to the properties of a node can affect any descendents.

3. If no ancestor has an entered value, the default value is used. A default value is assigned bythe system administrator.

Global properties that inherit follow a slightly different path. In step 2, as Data RelationshipManagement moves up the hierarchy in search of an entered value, it encounters the ancestorsin the controlling hierarchy. When the system administrator creates a global property, acontrolling hierarchy must be designated for the property. A controlling hierarchy tells thesystem which hierarchy to use to determine the inheriting value for a global property.

Many tools are available in Data Relationship Management for maintaining inherited values:

● Locking a value so that it cannot be overridden at a descendant

● Clearing all descendant values for a particular property

● Removing an overridden value so that the property inherits from a node above

Validations and VerificationsValidations and verifications are tests to ensure that hierarchy rules are observed. They helpenforce business rules.

● Validations—run automatically (in real-time) as users edit the structures and properties ofhierarchies. Validations are automatically performed for the node being edited and also forits parent.

● Verifications—run on-demand (as a batch) after users make a set of changes. Users canchoose specific verifications or run a set of verifications defined by the system administrator.

Data Relationship Management Components 17

Page 18: DRM Manual

Validation and Verification ExampleAn organization has a business rule that requires that a sales representative assigned more than20 customers obtain special approval from the marketing department.

● A validation using this business rule within Data Relationship Management permits no morethan 20 customers to be added to a sales representative node.

● A verification using this business rule reports only upon sales representatives with morethan 20 customers.

Comparing Validations and Verifications● Some business rules call for real-time enforcement and, therefore, should be defined by the

system administrator as validations.

● Other business rules only need to be monitored and should be established as verifications.In the preceding example, a verification is probably more appropriate because, in certaincircumstances, it is appropriate for a sales representative to have more than 20 customers.Validations are more appropriate for rules that can never be broken and require immediateenforcement.

ImportsData Relationship Management can import data from external systems of various formats,including text files, data extracts, and other sources. An import is always performed on a new,empty version that is created as part of the import process. Thus, the user can verify that theimport has run correctly before moving the imported data into a production environment. Afterthe data is verified, Blender can be used to incorporate the new data. Imports can be customizedand saved by any Data Relationship Management user who is authorized to run imports.

AutomatorAutomator is an alternative mechanism that enables Data Relationship Management users tomake bulk hierarchy changes. The changes are defined in a text file. The functions supportedare typical node and property manipulations. When Automator is used, the changes defined ina text file can be performed automatically and easily. Rather than using Automator, you canmake corrections to the data as it is processed.

BlenderBlender enables you to combine elements of two versions into a new version or to combineelements into an existing version. The elements to be blended can include various combinationsof structural elements such as hierarchies, nodes, and properties.

18 About Data Relationship Management

Page 19: DRM Manual

ExportsExports are tools that are used to transfer hierarchy data to external systems or to a databasetable. Exports are sometimes referred to as reports or extracts. Exports also serve as the mainreporting mechanism for Data Relationship Management. Data Relationship Managementprovides users a wizard-like export builder that enables them to create and save exports.

Exports can create paper reports for distribution or text files to be imported by external systems.If an external system requires a complex export that cannot be generated by the report writer, anew class of export can be created by the programming team and added into the export builder.Each export class has a set of parameters that enable it to be customized for a user’s specificrequirements.

Property QueriesUsing Structured Query Language (SQL) to query hierarchically structured data has always beendifficult (if not impossible) due to the recursive nature of the required query. Property queriesenable you to investigate the hierarchical structure and the property values of sets of nodeswithout the need for complex recursive SQL programming.

Property queries can be used for several purposes:

● To find nodes that meet certain criteria

● In exports and comparisons as a filtering mechanism

● As a parameter in a generic validation routine (providing queries additional functionalityas validations)

Users create a list of criteria, similar to the WHERE clause in a conventional SQL statement, andrun it against a set of nodes. The property query returns a list of nodes that meet the definedcriteria.

Note that:

● Property queries can be saved, so Data Relationship Management users can create and sharetheir own toolkit of queries

● The system administrator can create standard queries that are available to all users

Global property queries are similar to property queries but are run against the list of all nodesin a version instead of against a particular set of nodes within a hierarchy. Because a globalproperty query runs against a set of nodes without reference to a hierarchy, only global propertiescan be included in the criteria.

Property queries can be used as the basis for filters for exports and compares as well as the basisfor validations and verifications.

CompareThe Compare feature enables you to compare of the structure and node properties of hierarchiesand versions.

Data Relationship Management Components 19

Page 20: DRM Manual

Three Compare options are available:

● The standard Compare option requires that two points, one in each of two hierarchies, beselected. Their structures are then analyzed for differences. The points may be in differentversions.

● The Property Compare option enables two points, one in each of two hierarchies. Therepresentatives of a particular property within the hierarchies are then analyzed fordifferences.

● The Renamed Node Compare option duplicates the standard Compare option, except ittreats renamed nodes as being the same for comparison purposes. For example, assume thatHierarchy 1 in a compare includes nodes A, B, and C, and Hierarchy 2 includes nodes A, B,and C, but node C has been renamed to CC. The Renamed Node Compare option does notidentify differences between the two hierarchies. But the standard Compare option regardsnodes C and CC as different.

Note:

The Renamed Node Compare option should only be used between versions that are related(that is, one copied from the other).

A Compare process returns two lists:

● A list of all nodes that exist in the first hierarchy but not in the second

● A list of all nodes that exist in the second hierarchy but not in the first

Queries can be used to filter the lists of nodes to be compared.

Data Relationship Management Typical Data Life CycleMost organizations use Data Relationship Management on a cyclical basis that matches theirmanagement reporting periods (typically every four weeks or every month). Within eachreporting period, the use of Data Relationship Management follows a predictable pattern:

Table 4 Data Life Cycle

Task Principal Players

A Data Relationship Management working version iscreated as a copy of the finalized version for the previousperiod. The new version may contain multiple hierarchies(for example, for the chart of accounts, the organizationstructure, and the product structure).

System administrator

Changes are made to the working version by business userswho have access to Data Relationship Management.Validations are automatically performed as users enter oramend hierarchy data.

Data Relationship Management users

If necessary, bulk changes to hierarchy data are performedusing Data Relationship Management Automator.

Data Relationship Management users and/or thesystem administrator

20 About Data Relationship Management

Page 21: DRM Manual

Task Principal Players

As the reporting period deadline looms, the version statusis changed to submitted (changes by users are no longerpermitted). Validations and verifications are performed toensure the integrity of the data. Compare options can beused to identify changes.

System administrator

When data integrity is assured, the version status ischanged to finalized (no further changes are permitted).Simultaneously, the version status for the previousreporting period is changed from finalized to expired, andthe version is stored for possible future use in historicalanalyses or as an audit record.

System administrator

Exports are performed from the new finalized version tofeed hierarchy data to participating systems. After allexports are complete (and have been loaded by thedestination systems), all participating systems haveconsistent hierarchical data as a basis for the period endreporting process.

System administrator

And the cycle repeats for the next reporting period.

Existing organizational workflow constraints can be enforced by Data RelationshipManagement:

● Business rules might require that all new cost centers be approved by Corporate Treasury.In this case, a property can be added to indicate approval, and no nodes are exported toother systems until the property is changed to approved. Corporate Treasury can be grantedaccess to Data Relationship Management to update only the indicator property. A propertyquery can also be defined to identify indicator nodes.

● Business processes might require that all hierarchy updates be redirected to a dedicatedgroup responsible for implementing such updates. Following review and approval, usingAutomator, changes can be entered into a flat file for bulk loading into Data RelationshipManagement. This automated approach can significantly reduce potential typing errors.

Other tasks that are performed on an irregular basis:

● New hierarchies can be established to support an expansion in scope of the participatingsystems. Such an action is performed using a process similar to the initial load of DataRelationship Management with hierarchical data.

● Hierarchies can be restructured to match a change in business needs. Data RelationshipManagement includes tools, such as Blender, to facilitate this process.

Data Relationship Management Typical Data Life Cycle 21

Page 22: DRM Manual

22 About Data Relationship Management

Page 23: DRM Manual

2Getting Started

In This Chapter

Starting Data Relationship Management .. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .23

Data Relationship Management Desktop and Menus ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .25

Naming Metadata Objects .. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .32

Starting Data Relationship Management

➤ To start the Data Relationship Management client:

1 Select Start, then Programs, then Oracle EPM System, then Data Relationship Management, then DataRelationship Management .

Figure 2 N-tier Login Dialog Box

2 From the Connection drop-down list, select the login connection for the preferred application server.

If no login connections were defined, you are prompted to create a connection. For instructions,see “Creating Login Connections” on page 24.

3 In the User Name text box, enter a user name or use the default.

4 In the Password text box, enter a password.

Starting Data Relationship Management 23

Page 24: DRM Manual

Note:

User names and passwords are not case-sensitive.

5 Click OK.

Creating Login ConnectionsThe ability to create and save login connections was designed to simplify the login process andavoid inadvertent connections to the wrong environment. If no login connections were defined,the user will is prompted to create a connection.

➤ To create a login connection:

1 In the login dialog box, click the [...] button to the right of the Connection list to display the LoginConnections dialog box.

Figure 3 Login Connections Dialog Box

2 Enter a meaningful name for the connection, such as DevServer or Production, to indicate the environmentbeing used.

3 Enter the HTTP server URL for the Data Relationship Management application server.

4 Click Test to verify the specified URL.

5 Enter the primary User Name to be used with this connection.

6 Click OK to save and close the dialog box.

Additional connections can be created by clicking the […] button on the Login dialog box.Existing connections can be subsequently edited or deleted.

24 Getting Started

Page 25: DRM Manual

Changing Passwords

➤ To change your password:

1 From the Data Relationship Management main menu, select Tools, then Change Password.

The Change Password dialog box is displayed.

Figure 4 Change Password Dialog Box

2 Enter your old password in the Old Password text box.

3 Enter your new password in the New Password text box.

4 Enter your new password a second time in the Confirm Password text box.

Note:

Your password must contain three of the following elements:

● Uppercase letters

● Lowercase letters

● Numbers

● Special characters

5 Click OK.

Data Relationship Management Desktop and MenusThis topic describes the following areas of the Data Relationship Management Desktop:

● “Speed Buttons” on page 26

● “Main Menu Commands” on page 26

Data Relationship Management Desktop and Menus 25

Page 26: DRM Manual

● “Action Menus” on page 29

● “Hot Keys” on page 29

● “Using the Options Dialog Box” on page 29

Speed ButtonsSpeed buttons enable rapid access to frequently used functions within Data RelationshipManagement. They are displayed just following the menu bar of the Data RelationshipManagement Desktop and at the top of most other Data Relationship Management windows.To review the function of a speed button, hold the mouse cursor over the button. In a fewseconds, a hint will be displayed that explains the function of the button.

Table 5 Speed Buttons

Speed Button Action

Open currently selected hierarchy

Send current hierarchy tree view to a printer

Perform Take (copy/move) operation on currently selected node

Perform Put (paste) operation under currently selected node

Open Find Nodes dialog box to search for a node

Expand currently selected node to display it's children

Collapse currently selected hierarchy to only display top node

Open Properties Editor for currently selected version or hierarchy

Main Menu CommandsThe Data Relationship Management menu commands and their usage are listed following.

Table 6 File Menu Commands

Menu Item Description

Open Displays the Hierarchy Open dialog, box to select a hierarchy (or set of hierarchies) to open

Close Closes the active Hierarchy window

26 Getting Started

Page 27: DRM Manual

Menu Item Description

Close All Closes all open Hierarchy windows

Import Opens the Import dialog box, to import data from external files or systems

Export/Report Opens the Export dialog box, to run an existing export or to build a new export

Blender Opens the Blender dialog box, to blend data from two versions

Automator Opens the Automator dialog box, to process transactions from a flat file

Printer Setup Opens the Print setup dialog box

Print Preview From Top — Displays the hierarchy from the highest point

From Here — Displays the hierarchy from the selected node downward

Print From Top — Prints the hierarchy from the highest point

From Here — Prints the hierarchy from the selected node downward

Exit Closes Data Relationship Management

Table 7 Edit Menu Commands

Menu Item Description

Take Removes the selected node from its position in the hierarchy and places it in the clipboard

Put Pastes the contents of the last Take from the clipboard as a child of the currently selected node

Add Node Create a new node to insert into the hierarchy

Insert Node Insert an existing node into the hierarchy

Inactivate Opens the Inactivate Nodes dialog box

Reactivate Reactivates an inactive node

Remove Removes selected node from the hierarchy

Delete Opens the Delete Nodes dialog box

Annul Removes the node from the hierarchy, and deletes it if it is an orphan (For example, if a nodehas the same parent in all hierarchies in which it exists, then an annul will result in the nodebeing deleted)

Annul all below Annuls all nodes following the selected node

Remove Duplicates Opens the Remove Duplicates dialog box (enables property values to be removed)

Find Opens Find Node dialog box to search for node in currently selected hierarchy

Global Find Opens Find Node dialog box to search for node in all hierarchies of selected version

Select All Selects all the nodes in the list view pane of the active hierarchy

Data Relationship Management Desktop and Menus 27

Page 28: DRM Manual

Table 8 View Menu Commands

Menu Item Description

Properties Displays the Property dialog box populated with the current node’s properties

Expand All Expands the entire selected hierarchy tree to display all nodes (this may take a few moments for largehierarchies)

Collapse All Collapses the selected hierarchs, so that only the top node is displayed

Nodes by Default View — Displays default labels for nodes in the selected hierarchy

Description — Displays description labels for nodes in the selected hierarchy.

Default/Description — Displays default and description labels in the selected hierarchies

Defined Properties — Displays for each node the user-defined properties

List Ancestors — Ancestors of the selected node

Siblings — Siblings of the selected node

Descendants — Descendants of the selected node

Children — Children of the selected node

Links — All instances of the node in other hierarchies

Refresh Refreshes the screen from the database.

Refresh All Refreshes all items in the Version control window

Table 9 Tools Menu Commands

Menu Item Description

Property Query Opens the Property Query dialog box to search the selected hierarchy for nodes thatmeet a defined set of criteria

Global Property Query Opens the Global Property Query dialog box to search the version node list for nodesthat meet a defined set of criteria

Compare Opens the Compare dialog, to identify structural differences between two hierarchies

Property Compare Opens the Property Compare dialog box to identify property differences between twohierarchies

Renamed Node Compare Opens the Renamed Node Compare dialog box (similar to a standard Compare, exceptthat renamed nodes are not identified as 'different' between the two hierarchies)

Synchronize by Name — Search and synchronize based on node name

Property — Search and synchronize based on property value

Primary Node Name — Search and synchronize by primary node

Change Password Use to change user password.

Transaction History (Session) Opens dialog box to view all (or desired subset) of transaction activity performed viaData Relationship Management

Request History Opens the dialog box to view request history

28 Getting Started

Page 29: DRM Manual

Menu Item Description

Options Opens the Options dialog box to customize the local Data Relationship Managementinstallation

Action MenusThe action menu is a set of context-sensitive options that are displayed when the right mousebutton is clicked. The action menu items change based on the active object.

Hot KeysHot keys allow frequently used functions to be accessed by pressing a certain key or combinationof keys. If hot keys are available as a short cut for a function on a menu option, then theappropriate hot key is displayed next to that menu option. For example the <F11> key opensthe Property Editor.

Using the Options Dialog Box

➤ To set options:

1 From the Tools menu, select Options to display the Options dialog box.

On the General tab, various options can be configured that affect the way that the user interfacelooks and behaves.

Data Relationship Management Desktop and Menus 29

Page 30: DRM Manual

Figure 5 Options - General Tab

2 Select the Properties tab.

The default properties to be displayed in the list view frame and hotlist of the Hierarchy windowcan be selected.

30 Getting Started

Page 31: DRM Manual

Figure 6 Options Dialog Box - Properties Tab

3 In the Category drop-down list, select All to display all available properties.

4 Optional: In the Available list box, select a property and click the appropriate arrow to add a property.

5 Optional: In the Selected Properties list box, select a property and click the appropriate arrow to removea property.

6 Optional: From the Default Category drop-down list, select a category to open when the property editor isstarted.

7 Optional: Select Display All Tabs to display an additional property category tab in the property editor thatcontains all properties.

8 Optional: Select Multi Line Tabs for the property editor to display all property category tabs stacked onmultiple lines.

9 Select the Exports tab to set default parameters for running exports.

Data Relationship Management Desktop and Menus 31

Page 32: DRM Manual

Figure 7 Options Dialog Box - Exports Tab

10 From the Default Output Mode text box, select an option from the drop-down list.

11 Optional: Select the User internal viewer option.

12 To use an external viewer, click to browse for the program that you want to use as the viewer, for examplenotepad.exe.

13 Click OK.

Naming Metadata ObjectsWhen you create metadata objects such as exports, queries, compares, imports, and so on, donot use special characters other than the following:

● dash ( — )

● underscore ( _ )

● number sign ( # )

● ampersand ( & )

● dollar sign ( $ )

● at sign ( @ )

● backslash ( \ )

● forward slash ( / )

● period ( . )

Caution!

Using special characters other than those listed will cause issues.

32 Getting Started

Page 33: DRM Manual

3Using Versions, Hierarchies,

Nodes, and Properties

In This Chapter

Working with Versions ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .33

Working with Hierarchies and Nodes... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .38

Working with Properties .. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .58

Security .. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .66

Working with VersionsData Relationship Management groups hierarchies into versions. A version represents a single,independent set of data that is arranged into related hierarchies. All Data RelationshipManagement maintenance is performed within a single version. Users cannot copy or movenodes across versions. Compare and export are the only features that work across versions.

Version Control WindowImmediately after logging in, the Data Relationship Management desktop displays the Versioncontrol window, which lists a tree view of the available versions, along with the hierarchiescontained in each version.

Working with Versions 33

Page 34: DRM Manual

Figure 8 Version Control Window

Version StatusThe icon to the left of each version in the Version control window indicates the status of theversion. The version status is used to control the work flow of hierarchy maintenance and canonly be changed by the system administrator using the Data Relationship Management AdminTool. Table 10 describes each version status icon.

Table 10 Version Status

Status Description

WorkingUsers may edit versions with this status

Submitted Only system administrators are allowed to make changes to versions with this status (Users are notallowed to make changes)

FinalizedNo one can edit this version.

ExpiredNo one can edit this version.

Memory and Display StatusIn addition to version status, the memory status may be displayed as text, to the right of a versionor hierarchy name. Table 11 describes memory and display status.

34 Using Versions, Hierarchies, Nodes, and Properties

Page 35: DRM Manual

Table 11 Memory Status

Status Applies To Description

Open Versions Indicates that the version has been loaded into memory.

Shown Hierarchies Indicates that the hierarchy is currently displayed in a hierarchy window.

Detached Versions Indicates that the version is not attached to the database and changes are made in memoryonly. To retain the changes, this version must be manually saved.

Note:

The Open and Shown statuses are indicated by a bold version or hierarchy name.

Action MenuWhen a version is selected, various options are available on the right-click menu.

Figure 9 Version Control Window - Right-click Menu

Table 12 describes the right-click menu options.

Working with Versions 35

Page 36: DRM Manual

Table 12 Version and Hierarchy Right-click Menu Options

Menu Option Description

New Version — Create a new version in a detached state

Hierarchy — Create a new hierarchy within the current version

Open Open the current hierarchy

Open All Open all hierarchies in the current version

Open Selected Prompts user to select which hierarchies to open

Open Baseline Prompts user to select a hierarchy to open in a baseline version

Close Version Close the current version

Close Baseline Close the baseline version of the current version

Copy to New Copy the current version to a new version in a detached state

Save Save a detached version

Create As Of Create snapshot (in a detached state) of current version as of some past date and time byrolling back transactions that occurred after that time

Use Save to save the as of version if a permanent copy is desired.

Delete Delete the currently selected version or hierarchy

Properties Show properties of currently selected version or hierarchy

Assign Validation — Assign existing validations to be run

Verification — Assign existing verifications to be run

Verify Assigned — Run the assigned verifications

Selected — Select verifications to run

Verification Messages View status messages from verifications

Clear Verify Results Clear the results of the verifications run

List Global Nodes — Display list of global nodes in current version

Orphan Nodes — Display list of orphan nodes in current version

Controlled Properties Show list of global properties controlled by current hierarchy

Show Status Column Shows the version status column.

Creating As Of VersionsFrom the right-click menu of the Version control window, the create as of option enables youto create a snapshot of a current version at some past date and time by rolling back transactionsthat occurred after that time. Whenever a version is created or copied, and the AllowAsOf systempreference is set to True, a baseline version is also created. The baseline version is read-only and

36 Using Versions, Hierarchies, Nodes, and Properties

Page 37: DRM Manual

is not displayed in the Version control window. As changes are made to the version, thetransactions are logged. These transactions can be used as a means to roll the baseline versionforward to any point in time to generate a snapshot at that point.

The desired point in time for the As Of Version can be specified as one of the following:

● A date and time

● A date offset from the current date

● A specific transaction ID

Note:

When creating an As Of version, there can be a discrepancy when crossing Daylight SavingsTime boundaries. For example, if today is February 21 and you request an As Of for the priorSeptember 1 at 3:00 am, the As Of version that gets created is for September 1 at 4:00 am. Thisis because the current date is in Standard Time but the requested date is in Daylight SavingsTime. To adjust for this, you can request the As Of version for 2:00 am to get the 3:00 am data.The opposite occurs when starting in Daylight Savings Time and requesting a date in StandardTime — a 3:00 am request returns results for 2:00 am. For clients using Data RelationshipManagement to create daily delta exports using As Ofs, you can reduce the issue by selecting atime when no transactions are likely such as 3:00 am and verify that there were no transactionsthe day the export runs. Another approach is to have three versions of the export that differ onlyin the hour (3:00 am for normal, 2:00 am for one boundary and 4:00 am for the other boundary)and then schedule the normal export for most days and the special exports for the boundarydays.

➤ To create an as of version:

1 In the Version control window, right-click a version, and select Create As Of.

Working with Versions 37

Page 38: DRM Manual

Figure 10 Create Version As Of Dialog Box

2 Select one of the following time frames for the As Of version:

● Transaction Date/Time

● Transaction Date Offset (Days)

● Transaction ID

For the Transaction ID option, click to open the Transaction History dialog box. TheID of the desired transaction can then be determined. For more information, see Chapter 11,“Viewing Transaction History.”

3 Click OK.

Using the Version Criteria Dialog BoxIn some features of Data Relationship Management, the user may have the option to choosewhat type of version is desired for the specified operation. After a version is selected, the VersionCriteria dialog box enables the user to select one of these options:

● Normal Version - The selected version in its current state is used.

● Use Baseline - The baseline version of the current version is used.

● Create As Of - A snapshot of the current version at some past date and time is used.

Working with Hierarchies and NodesA hierarchy is a logical set of nodes within a version. Each hierarchy is usually associated with acertain view, external system, or management report. The set of nodes that makes up a hierarchyare all descendants from a single top node. In that way, a hierarchy is defined by its top nodeand represents all the nodes in the hierarchical relationships below that node.

38 Using Versions, Hierarchies, Nodes, and Properties

Page 39: DRM Manual

● Hierarchies are contained within a version, and a single version may contain multiplehierarchies.

● Hierarchies provide the main interface for a user when working with Data RelationshipManagement.

Using Shared NodesIn Data Relationship Management, the concept of shared nodes is defined as multiple instancesof a node within the same hierarchy. Explicitly shared nodes created during manual maintenanceand import processes share global property values with the primary node. The global propertiesfor shared nodes automatically reference the values of the primary node. Local properties canbe specific to each shared node.

With shared nodes you can:

● Automate the alternate naming of the shared nodes for operations like drag and drop (usingthe Ctrl key) and Add/Insert

● Confirm before creating a shared node

● Create system-level properties that map shared nodes

● Create system-level referential integrity between shared nodes and primary nodes (forexample you cannot delete a primary node that is linked to shared nodes)

● Display the structure below a shared node

● Move between shared nodes and the primary node

● Remove and delete nodes that are the primary shared node

● Rename the primary shared node (thus renaming all the shared nodes)

● Display a full member list that can be used for drag and drop-type operations used to createthe shared nodes

● Find and display a shared node list to be used for navigation and analysis purposes

The system preference SharedNodeMaintenanceEnable enables the shared nodes. Thispreference is disabled by default. In addition, a hierarchy-level property EnableSharedNodesenables shared nodes on a hierarchy by hierarchy basis. This property is disabled by default.

Note:

If shared nodes are enabled, the default shared node system preferences (delimiter, unique string,zero-pad length) should not be changed.

For information on system preferences and properties, see the Oracle Hyperion Data RelationshipManagement N-tier Administrator's Guide.

Additional properties are defined in Data Relationship Management to provide informationabout and between primary and shared nodes. These read-only properties are automaticallycreated:

Working with Hierarchies and Nodes 39

Page 40: DRM Manual

● Primary Node — Boolean property indicating if a node has shared nodes that point to it

● Shared Node — Boolean property indicating if the node is a shared node

● Primary Node Name — String property that returns the primary name portion of the sharednode name. For non-shared nodes, this property returns the node name in its entirety.

● Primary Node Has Descendants — Boolean property indicating if the primary node hasstructure below it. This is only populated on shared nodes.

● Primary Node Descendants — Comma-delimited list of the descendants of the primarynode. This is only populated on shared nodes where the primary node has structure belowit.

● Primary Node Ancestors — Comma-delimited list of the ancestors of the primary node.This is only populated on shared nodes.

● Shared Map — Associated nodes property that maps the shared/primary nodes. Thisproperty is populated for shared and primary nodes.

● Missing Primary Node — Boolean property indicating that the shared node resolves to aprimary node that does not exist

● Primary Not in Hierarchy — Boolean property that indicates if the primary node is not inthe same hierarchy

Adding and Inserting Shared NodesAssuming the system has shared nodes enabled, if you try to add a node that already exists, thesystem asks you if you meant to insert a node. If Yes, then the Insert Node dialog box opens. IfNo, then an error message displays saying the node already exists in the hierarchy and you mustselect a different name for the node. In the Insert Node dialog box, select the Create Shared Nodeoption.

The Alternate Named shared node is created if needed. The drag and drop operations areenhanced to detect the CTRL key. If you hold CTRL and select a node, the system copies andinserts an Alternate Named shared node. When you drag and drop without the CTRL key, DataRelationship Management does a normal move operation.

Removing and Deleting Primary Shared NodesDuring a Remove, the system checks to see if the node being removed is a primary node. If it isa primary node, you must confirm the Remove operation. Upon confirmation, the system movesthe primary node to the location of the first shared member that does not cause a duplicate issueand then removes that shared member. This has the effect of removing the primary memberfrom the original location but does not remove the primary member from the hierarchy. If thereis no shared member available or that does not cause a duplicate issue, then the primary nodeis just removed.

During a Delete, the system checks to see if the node being removed is a primary node. If it is aprimary node, you must confirm the delete operation. Upon confirmation, the system deletesall the shared nodes and the primary node.

40 Using Versions, Hierarchies, Nodes, and Properties

Page 41: DRM Manual

Renaming Primary Shared NodesWhen you rename a node, the system checks to see if the node being renamed is a primary node.If it is a primary node, you must confirm the rename operation. Upon confirmation, the systemrenames the primary node and the shared nodes. Only the primary node can be renamed. Thesecondary shared nodes cannot be renamed.

Move to Primary NodeUse the Move to Primary Node menu command to jump from the shared node to the primarynode.

Converting Shared Nodes to Primary NodesYou can convert a shared node to a primary node if the primary node does not already exist inthe hierarchy. If the primary node already exists, an error message is displayed.

Displaying Shared NodesFollowing are different ways to display shared node information in the system:

● Showing Structure Below a Shared Node — The Hierarchy viewer displays the structurebelow a shared node. This structure is read-only and is italicized to indicate that it iscontrolled from a different location. Drag and drop and maintenance operations are notvalid in this section.

● Full Node List for Drag and Drop Creation — A member list that contains all of the nodesin the hierarchy is provided so you can drag and drop into the hierarchy. In the HierarchyNode list, you can double click to show the node.

● Find and Display Shared Nodes — Select the show shared nodes on a single result optionto find all instances of a node. A shared node list is displayed if a single node is returned bythe initial search. The shared node list provides detailed information for each shared nodeand allows for further navigation to any instance of that node in the hierarchy.

Opening Hierarchies and NodesA hierarchy may be opened from the Version control window or from the main menu. Whenthe first hierarchy for a particular version is opened, the entire version is loaded into memory.

➤ To open a single hierarchy, do one of the following tasks:

● From the Version control window, double-click the hierarchy name.

● From the Version control window, right-click the hierarchy and select Open.

Working with Hierarchies and Nodes 41

Page 42: DRM Manual

➤ To open all hierarchies within a version, from the Version control window do one of thefollowing:

● Right-click the version name and select Open All.

● Double-click the version name.

Each hierarchy within the version opens in a separate window.

➤ To open multiple hierarchies:

1 Right-click the version name (or any hierarchy within a version) and select Open Selected.

2 Select a version from the drop down list at the top of the dialog box.

A list of the hierarchies contained within the selected version are listed at the bottom of the dialogbox.

3 Select hierarchies to open by using the <Ctrl> key and then click OK.

Hierarchy WindowThe hierarchy window title bar shows the name of the hierarchy and version that are currentlydisplayed.

● To move a Hierarchy Window, click anywhere in the window title bar. While holding theleft mouse key down, move the window to the desired location.

● To change the size of a Hierarchy Window, slowly move the mouse across a window’s border.The cursor changes to a doubled arrow bar. Click and hold the left mouse key down, andthen move the mouse up, down, or left and right, to resize the window.

● Data Relationship Management enables the opening of as many Hierarchy Windows asdesired, although no hierarchy may be displayed in more than one window at a time. Toselect a specific hierarchy, click on any surface area of the desired window. The title bar thatyou click on changes colors and is displayed in the foreground.

● The top (or root) node of a specified hierarchy view can be changed. To change the top nodeof the view, select the desired node then right-click and select View From Here from theaction menu. To revert to viewing the hierarchy from its true top node, right-click and selectView From Top from the action menu.

42 Using Versions, Hierarchies, Nodes, and Properties

Page 43: DRM Manual

The Hierarchy Window contains two main panes. The pane on the left is the tree view andpresents the structure of the hierarchy. The pane on the right is the list view or child view andcontains the children of the selected node. The list view also displays certain properties of thechild nodes. The specific properties to be displayed can be configured using the View Nodes Bybutton on the Hierarchy Window toolbar. You may also change the properties that are displayedin the Options dialog box from Tools.

The following table describes each Hierarchy Window speed button.

Table 13 Hierarchy Window Speed Buttons

Speed Button Action

Clear all marked nodes Removes mark from all nodes in the hierarchy (Refer to section onMarked Nodes for additional information)

Expand to marked nodes Expands hierarchy view to display all marked nodes

Move to next marked node Changes selected node to next node in the hierarchy that is marked

Move to previously selected node Enables selected node to be toggled back and forth between 2nodes

Hide/show child panel Opens or closes the list view pane of the Hierarchy Window

Move to parent node Changes selected node to the parent of currently selected node ifthe parent is visible in the current view

View nodes by Determines the properties that are displayed by each node in thehierarchy. Options are:

Default View – displays default properties

Description – displays description property for the node

Default/Description – displays default properties and description

Defined Properties – user may configure any of the availableproperties to display

Dock/undock the Property Edit window Determines the location in which to display the Property Editwindow

Options are:

None – window not displayed.

Undocked – window displayed independent of Hierarchy Window

Show at Right – window displayed as right-most pane of HierarchyWindow

Show at Bottom – window displayed as bottom pane of HierarchyWindow

The hierarchy window right-click menu options are described in the following table.

Working with Hierarchies and Nodes 43

Page 44: DRM Manual

Menu Option Description

Properties Shows the properties for the selected node

Synchronize By Name (or Property) Searches for nodes in all opened hierarchies based on their name or a commonproperty value

Take Copies the currently selected node

Put Pastes from the clipboard under the currently selected node

Add Node Adds a new node to the hierarchy

Insert Node Inserts an existing node into the hierarchy

Model After Enables you to model a new node after an existing node

Copy Properties Enables you to copy properties from a node.

Paste Properties Enables you to paste copied properties to a node.

Inactivate Inactivates a node

Reactivate Reactivates a node

Remove Removes the node from the current hierarchy and any other hierarchies whereit has the same parent (However, the node is not deleted from the version, sothat it is available for later re-insertion)

Delete Removes the node from all hierarchies and deletes the node from the version.

Order Children Enables the sort order of limbs and leaves to be set graphically

Move to Previous Node Moves insertion point to the previously selected node.

Expand From Here Expands the hierarchy from the selected node.

Collapse From Here Collapses the hierarchy from the selected node

View From Here — Makes the selected node the top node of the hierarchy.

From Top — Reverts from a selected node as the top node to the true top nodefor the hierarchy.

Lists Ancestors — Lists ancestors of the selected node

Siblings — Lists siblings of the selected node

Descendants — Lists descendants of the selected node

Children — Lists children of the selected node

Links — Lists links of the selected node

Verify Assigned — Runs the assigned verifications for the node

Selected — Runs the selected verifications for the node

Transaction History (Node) Displays the transaction history for the node

44 Using Versions, Hierarchies, Nodes, and Properties

Page 45: DRM Manual

Navigating Hierarchies

➤ To select a node, click a node in the tree view or list view pane.

Note:

To select multiple nodes, the list view pane must be used.

➤ To expand a node, do one of the following:

● Double-click on the limb in the tree view or list view pane.

● Click the plus (+) or minus (-) sign next to a limb. A plus sign (+) next to a limb indicatesit is closed. A minus sign (-) indicates it is open.

Adding and Inserting NodesA node can be included in a hierarchy in one of two ways:

● An existing node, not currently in the hierarchy, can be inserted.

● A new node can be created.

A new node can also be modeled after an existing node using the Model After function.

Caution!

Using commas in node names can cause difficulties when working with certain properties thatare comma-delimited, such as Ancestor List, Child List and client-created node lists. In addition,using the characters defined in the system preferences for the shared node separator and thehierarchy separator can cause unpredictable behavior and should be avoided. If the querywildcard characters asterisk ( * ) and underscore ( _ ) are used in a node name they cannot beeasily searched for unless a derived formula is used to search for them using the Pos function.

➤ To insert a node:

1 Select the point of insertion, which will be the future parent of the new node.

2 Do one of the following:

● Right-click to and select Insert Node.

● From the main menu, select Edit, then Insert Node.

● Use the keyboard shortcut <Ctrl+I>.

Working with Hierarchies and Nodes 45

Page 46: DRM Manual

3 Select the name of the new node using one of these methods:

● Enter the name of the node. If a name is entered that does not correspond to an existingnode, you are prompted to locate an existing node.

● Click and choose a node from an existing hierarchy.

4 Click Insert.

➤ To create and add a new node:

1 Select the point of insertion, which will be the future parent of the new node.

2 Open the Add Node dialog box by performing one of the following:

● Right-click to display the action menu and select Add Node.

● From the main menu select Edit, then Add Node.

46 Using Versions, Hierarchies, Nodes, and Properties

Page 47: DRM Manual

3 Enter the name and description of the new node. If a name is entered that corresponds to an existing node,the user will be prompted to use the Insert Node dialog box.

4 Define the new node as Limb or Leaf

5 Use the Copy Properties option to copy some or all properties of an existing node to the new node if desired.

6 Click Add to create and add the new node.

When common prefixes are being used for node names, an option is available to pre-fill the AddNode dialog box with the desired prefix. The hierarchy-level properties PrefillLeafProp andPrefillLimbProp can be set to point to any node-level properties. Then when creating a newnode, the name field is pre-filled with the value of the designated property for the parent of thenew node.

Next ID FunctionThe Next ID function enables the automatic generation of node names using sequentialnumerical IDs and node prefixes. For example, a set of nodes can be created where each of themhave a name like Org000xxx, where:

● Org is the node prefix and can be any desired character string.

● 000xxx is the sequential ID and increments by 1 starting at 1.

This feature must be enabled by a Data Relationship Management system administrator for itto be visible to Data Relationship Management users:

● The System Preference Allow NextID Generation must be set to True.

● The System Preference Allow NextID Key Creation Level can be set to Admin, Funct, Any,or None and determines the level of user that is able to create new ID keys.

To use the Next ID function, type the desired prefix into the node name field and click the idbutton.

● If the prefix already exists in the system, then an ID value is returned that is one greater thanthe last ID previously generated.

● If the prefix has not been used before, then an ID value of 1 (with the appropriate numberof leading zeros) is returned.

The total length of the ID (excluding the prefix and including any leading zeros as necessary) isdetermined as follows:

● The hierarchy properties IDLengthLimbProp and IDLengthLeafProp can be set to point tonode-level properties that specify the desired ID length for the specified node.

● If the IDLengthLimbProp and IDLengthLeafProp properties are not set, then the length ofthe next sequential ID will be used without any leading zeros.

Working with Hierarchies and Nodes 47

Page 48: DRM Manual

Model AfterWhen a new node is created, it typically shares many common characteristics with existing nodes.The Model After feature enables a new node to be modeled after an existing node and thusimproves the efficiency of the node creation process by eliminating redundant steps.

To use this feature, open the Hierarchy Window and select the desired node to be modeled after.The Model After dialog box can be opened in one of the following ways:

● Right-click to display the action menu and select Model After.

● From the main menu select Edit, then Model After.

● Use the keyboard shortcut <Ctrl+M>

Figure 11 Model Nodes Dialog Box

The Node to Model field shows the name of the currently selected node. If another node is to

be used to model after, click to open the Select Node dialog box. Any node can then beselected from any hierarchy in the current version.

A node name can also be typed directly into the Node to Model field. However, if the name isnot found as an existing node, it is displayed with strike through and cannot be used to modelafter.

In the New Node field, enter the name of the new node. If the name already exists, the name isdisplayed with strike through.

The node name can also be created using the Next ID function by clicking the id button.

In the New Description field, the description of the new node can be entered.

Copy PropertiesThe following options can be chosen for copying properties from the original node to the newnode:

● None - no properties are copied.

● Defined - only defined properties are copied.

48 Using Versions, Hierarchies, Nodes, and Properties

Page 49: DRM Manual

● Selected - clicking opens the Select Properties dialog box to select the properties to copy.

● All - all properties are copied.

After the desired properties option is selected, clicking the Fetch button populates each of thetabs following with the appropriate data.

Hierarchies TabThis tab lists each hierarchy in which the node to model after currently exists. The parent of thenode in each hierarchy is also listed.

Global Properties TabThis tab lists each of the global properties of the node to model after based on the copy propertiesoption selected.

Local Properties TabThis tab lists each of the local properties of the node to model after based on the copy propertiesoption selected.

Figure 12 Model Nodes Dialog Box - Local Properties Tab

The local properties of the node to model after is listed for each hierarchy in which it exists. Thevarious hierarchies can be selected from the Hierarchy drop-down list.

Automator ProcessingAfter each of the desired options for the model operation are set, clicking the Automate buttondisplays the Data Relationship Management Automator dialog box.

Working with Hierarchies and Nodes 49

Page 50: DRM Manual

Figure 13 Automator Dialog Box

This window displays each of the underlying Automator commands that are used to create thenew node and copy the desired properties. Clicking the Process button executes each of thecommands. The result of each command can be verified by reviewing the Status column.

You can save the automator to a flat file that you can edit and reuse.

This completes the modeling of the new node. The Automator window and Model Nodeswindows can now be closed.

Moving NodesNodes may be moved within a hierarchy or to a different hierarchy:

● Moving a node within a single hierarchy removes the node from its original parent andplaces it under the new parent.

● Moving a node to a different hierarchy is treated like a copy. The node is left unchanged inits original hierarchy. This function is identical to inserting an existing node.

➤ To move a node, perform one of the following steps:

● Drag and drop the node onto its new parent node in the hierarchy

● Use the Take and Put functions by selecting the node to be moved in one of the followingways:

❍ Right-click and select Take.

❍ Use the <Ctrl+T> keyboard shortcut

❍ From the main menu, select Edit, then Take.

● Select the new parent node for the move and do one of the following:

50 Using Versions, Hierarchies, Nodes, and Properties

Page 51: DRM Manual

❍ Right-click and select Put.

❍ Use the <Ctrl+P> keyboard shortcut

❍ From the main menu, select Edit, then Put.

Node Move ProblemsA move to a new hierarchy may be unsuccessful for any of the following reasons:

● A node with the same name already exists in the destination hierarchy.

● One of the descendants of the moved nodes already exists in the destination hierarchy.

● The new relationship fails an assigned validation.

Moving nodes within a hierarchy that has some shared nodes with alternate hierarchies andsome non-shared nodes may cause a duplicate to be created in the alternate hierarchy. This failsthe Data Relationship Management integrity constraint as described preceding and prevents themove operation. To accomplish the move, the user must first remove the node being movedfrom the alternate hierarchy before moving it to the main hierarchy.

For many users, this causes an issue in the extra maintenance steps needed to perform changes.This can also be a problem when the moves are being done via Automator scripts or through anautomated system via the API.

Relaxed Move OptionTo facilitate a move that requires a node to be removed from an alternate hierarchy, you can usethe Relaxed Move option. If the System Preference AllowRelaxedMove is set to True, the RelaxedMove is allowed. If the system preference is set to False or does not exist, then the normal integrityconstraints are enforced.

When moving a node, the Relaxed Move enables the new parent in the main hierarchy to takeprecedence over any conflicting parental relationships for this node in other hierarchies.

Consider the four hierarchies in the following example:

Hier 1 Hier 2 Hier 3 Hier 4

A X Z S

+B +X1 +Z1 + C

| +C | +X2 +Z2 + 111

| +111 | +111 +111

+D +D

The intent is to move node 111 from C to D in Hier 1. When AllowRelaxedMove is false, themove fails due to the insert under D in Hier 2 causing a duplicate node.

When AllowRelaxedMove is true, the following occurs:

Hier 1 Hier 2 Hier 3 Hier 4

A X Z S

Working with Hierarchies and Nodes 51

Page 52: DRM Manual

+B +X1 +Z1 + C

| +C | +X2 +Z2

| | +111

+D +D

+111 +111

Note that 111 is removed from under X2 in Hier 2 because it now exists under D in that hierarchy.

Using Node Deletion MethodsThere are four methods by which a node can be deleted. The subtle differences in the terminologyused are significant. The methods are listed in decreasing order of severity in the following table.

Table 14 Node Deletion Methods

Action Result

Delete Removes the node from all hierarchies and deletes the node from the version

Remove Removes the node from the current hierarchy and any other hierarchies where it has the same parent(However, the node is not deleted from the version, so that it is available for later re-insertion)

Annul Performs a Remove on the node in all hierarchies where it has the same parent, and also Deletes thenode if it is then an orphan:

● For example, if a node has the same parent in all hierarchies in which it exists, then an Annul willRemove the node from all hierarchies and then Delete it because it is then an orphan

● If the node does not have the same parent in all hierarchies, the Annul will produce the same resultas the Remove

Inactivate Flags the node as inactive so that it can be easily filtered from an export

Deleting NodesOnly nodes with no descendents can be deleted.

➤ To delete a node, select a node or set of nodes and do one of the following:

● Right-click and select Delete.

● Use the <Ctrl+D> keyboard shortcut.

● From the main menu, select Edit, then Delete.

If the option to merge nodes is enabled, the Delete Nodes dialog box opens and presents theselected nodes and their associated merge status. The user can then choose which of the selectednodes to actually delete.

It is important to note that when deleting a hierarchy, the nodes within that hierarchy are notdeleted. If the nodes do not exist in any other hierarchy within the version, then they becomeorphans after their resident hierarchy is deleted. If a large group of nodes needs to be deletedfrom a hierarchy, the Annul All Below command can be used.

52 Using Versions, Hierarchies, Nodes, and Properties

Page 53: DRM Manual

Removing Nodes

➤ To remove a node, and all of its children, select the node and do one of the following:

● Right-click and select Remove.

● Use the <Ctrl+R> keyboard shortcut.

● From the main menu, select Edit, then Remove.

Annulling NodesWhen a node is annulled, the node is removed from the hierarchy, and deleted it if it is an orphan.For example, if a node has the same parent in all hierarchies in which it exists, then an annulwill result in the node being deleted.

➤ To annul a node:

● Use the <Ctrl+N> keyboard shortcut.

● From the main menu, select Edit, then Annul.

➤ To annul a set of nodes:

● Use the <Ctrl+L> keyboard shortcut.

● From the main menu, select Edit, then Annul All Below.

Inactivating NodesOnly nodes with no active children can be inactivated.

➤ To inactivate a node, select a node or set of nodes and do one of the following:

● Right-click and select Inactivate.

● Use the <F12> keyboard shortcut.

● From the main menu, select Edit, then Inactivate.

If the option to merge nodes is enabled, the Inactivate Nodes dialog box opens and displays theselected nodes and their associated merge status. Merge nodes may then be selected in anidentical manner as when a node is deleted. Inactivated nodes are displayed with a red slash toindicate their status.

Reactivating Nodes

➤ To reactivate a node, select a node or set of nodes and do one of the following:

● Right-click and select Reactivate.

● Use the <Ctrl+F12> keyboard shortcut.

Working with Hierarchies and Nodes 53

Page 54: DRM Manual

● From the main menu, select Edit, then Reactivate.

The node is displayed normally without the red slash.

Orphan NodesAn orphan node is defined as a node that exists in a version but that is not assigned to anyhierarchy within that version. Orphans may exist pending a clean-up to completely removethem, or they may be awaiting re-allocation to one (or more) hierarchies in the version.

Orphan nodes within a version may be viewed by right-clicking on a version in the Versioncontrol window and selecting List, then Orphan Nodes. A hot list of orphan nodes is displayed.

Figure 14 Orphan Nodes

You can add an orphan node to a hierarchy by doing one of the following:

● Insert node and type the name of orphan node

For more information, see “Adding and Inserting Nodes” on page 45.

● Drag an orphan from the orphan node hotlist into the hierarchy

It is possible for an orphan node to have descendants that are not orphans. To avoid this, thelist of orphan nodes should be reviewed regularly. By right-clicking on each orphan in the hotlist and selecting the View Structure option, a list of the orphan node's descendants is displayed.

Deleting Orphan NodesYou can delete one or more orphan nodes. With the Delete option, the user will be promptedfor merge information if the system is configured to require merging. With the Destroy option,the node is deleted immediately regardless of the merge requirements.

Nodes with children can be deleted.

54 Using Versions, Hierarchies, Nodes, and Properties

Page 55: DRM Manual

Merging NodesTracking merge information is a Data Relationship Management option that enables users tospecify nodes that should be used in place of deleted or inactivated nodes. External transactionsystems supported by Data Relationship Management may still have transactions that refer tothe deleted node. By keeping a merge list, Data Relationship Management is able to feed thesesystems appropriate node mappings that allow them to roll the data to a new valid node.

Merging is an option that can be configured by the system administrator in the Data RelationshipManagement Admin Tool. If the option to merge nodes is enabled within Data RelationshipManagement, then an appropriate dialog box is displayed when an attempt is made to delete orinactivate a node. This series of forms ensures that valid merge nodes are selected for each deletedor inactivated node.

Figure 15 Inactivate Nodes Dialog Box

➤ To define a merge node from the Delete Nodes or Inactivate Nodes window,

1 Do one of the following tasks:

● Enter the name of the merge node in the Merge Node column.

● Click and select a node name from an existing hierarchy.

The merge node defaults to the parent of the selected node.

2 Click Next to continue the delete or inactivate process.

The results of the delete/inactivate validation process are displayed. Valid transactions arepresented in the top portion. Invalid transactions, along with an explanation, are presented inthe bottom portion. To fix an invalid transaction, click Back to return to the merge selectionform.

3 To complete the operation for approved transactions, click Delete or Inactivate.

If the delete option is disabled or the delete function is unsuccessful, it may be due to one of thefollowing reasons:

● A deletion can only be performed by users who are granted authority by the systemadministrator.

● A node may not be deleted if it has descendants.

Working with Hierarchies and Nodes 55

Page 56: DRM Manual

● The delete may fail an assigned merge validation.

Finding NodesThere are two different ways to search for nodes. The Find feature searches for nodes within theselected hierarchy while the Global Find searches for nodes in any hierarchy within the selectedversion.

➤ To use either find feature:

1 Do one of the following:

● To use the Global Find feature, select a version in the version and do one of the following:

❍ Use the <Ctrl+G> keyboard shortcut.

❍ Use the main menu and select Edit, Global Find.

● To use the Find feature, select a hierarchy in the version and do one of the following:

❍ Use the <Ctrl+F> keyboard shortcut.

❍ Use the main menu and select Edit, then Find.

Figure 16 Find Node Dialog Box

2 In the Search For text box, enter a string to search

3 From the Search In drop-down list, select one of the following node properties to search:

● Name

● Description

● DisplayByString (available for Find but not Global Find)

56 Using Versions, Hierarchies, Nodes, and Properties

Page 57: DRM Manual

4 Select Perform Exact Match to find nodes that match the search string exactly. This option is only availablewhen searching in Name.

5 In the Display Options section, select one of the following options:

● Show in Lists to display a Hotlist of the nodes found

● Mark Nodes to mark the nodes in the hierarchy window

● Both to display a Hotlist and mark nodes

6 Select Go to First Node in List to automatically locate the first node in the search results and select it inthe hierarchy window.

7 Click Find to perform the search.

Sorting NodesNodes are sorted in Data Relationship Management according to the following default rules:

● Limbs are sorted ahead of leaves.

● Nodes are then sorted by their name.

This default sort order is similar to how folders and files are sorted by default in the MicrosoftWindows Explorer.

Custom Sort OrderNodes can also be sorted in any explicit custom sort order (although limbs are always sortedahead of leaves.) The sort order can be defined by any property that has a property data type ofSortOrder. (The SortOrder data type is special case of an Integer data type.) By default, any DataRelationship Management installation includes a property called Sort Order (assigned to theDefault property category) that can be used for this purpose.

To sort a hierarchy according to the value of a node-level sort order property, the hierarchy-level property StandardHierSort must have its value set to point to the appropriate node-levelproperty that contains the sort order.

A custom sort order can also be used that applies only to a specific Data RelationshipManagement user ID, enabling users to customize their display of Data RelationshipManagement data without impacting other users of the same hierarchy. This is controlled bythe hierarchy-level property UserHierSort. If this property has been set to point to a node-levelproperty that has a data type of Sort Order, then this sort order takes precedence over both theStandardHierSort property and the default sort order.

If there is no value assigned to the hierarchy-level property StandardHierSort nor toUserHierSort, then the default sort order is applied.

The value of a custom sort order property can be set in any of the following ways:

● Sort order values can be loaded into a node-level sort order property when data is initiallyimported into Data Relationship Management (see following for details.)

● Explicit values can be defined for the sort order property for any node.

Working with Hierarchies and Nodes 57

Page 58: DRM Manual

● If a sort order property has been selected for a hierarchy’s StandardHierSort or UserHierSortproperties, then the Order Children menu option is available by right-clicking on any nodein a hierarchy. This opens a dialog box that enables the sort order of limbs and leaves to beset graphically.

● A node-level sort order property might be defined as Derived, and so might be automaticallypopulated with a sort order.

Removing Custom Sort OrdersTo disable the use of any sort order, the value of the hierarchy-level property controlling the sortorder can be removed by right-clicking on it and selecting Remove Value.

Node SecurityNode security settings can only be assigned by a Data Relationship Management user withadministrative privileges. Security settings are maintained as property values, just like any otherproperties of a node. They are maintained in Data Relationship Management (and not in theData Relationship Management Admin Tool) because Data Relationship Management offersbetter mechanisms for navigation within the hierarchy. For additional details, refer to the sectionon Node Access Group security in the Oracle Hyperion Data Relationship Management N-tierAdministrator's Guide.

Working with PropertiesProperties are data elements that are associated with nodes, similar to fields in a database.Properties enable Data Relationship Management to store extra information about each node.While there are a set of default properties including Name and Description, the systemadministrator can add as many properties as needed to support the subscribed systems.

Using the Property EditorThe property editor enables users to examine and edit property values for the currently selectednode.

➤ To access the editor, select a node and do one of the following:

● Right-click and select Properties.

● Use the <F11> keyboard shortcut.

The Property Editor is displayed either docked at the bottom or right, or undocked to thehierarchy window based on the user preference defined under options in the Tools menu.

58 Using Versions, Hierarchies, Nodes, and Properties

Page 59: DRM Manual

Figure 17 Property Editor

Note that selecting View, then Properties from the main menu or using the Properties speedbutton on the main tool bar displays the Property Editor for the version or hierarchy selectedin the Version Control Window.

Note:

You have edit rights to the property if property name is bold.

CategoriesThe Property Editor displays lists of properties categorized by a series of tabs which each definea Property Category. Each property category represents a set of logically related properties suchas those belonging to a particular external system (for example, SAP or Essbase), or a specificfunctional area within the company. The system administrator can create as many propertycategories as needed. Data Relationship Management includes the built-in property categorieslisted in the following table.

Table 15 Property Categories

Category Description

System Properties related to a node’s identifying characteristics, such as ID, name and description

The only change that can be made to this category is assigning the read-only flag for individual users.Users with read-only access cannot edit values in the category, but can view them.

Note: Properties cannot be assigned to thism’ category.

Stats Properties that provide statistical information about the node such as number of children, number orsiblings

Validation Validations assigned for the node – one property for each validation

Working with Properties 59

Page 60: DRM Manual

Category Description

Verification Verifications currently assigned for the node – one property for each verification

Leaf Access Node security groups and their leaf access levels for the node – one property for each group

Limb Access Node security groups and their limb access levels for the node – one property for each group

Note the following information:

● Not all property categories are visible to all users, because the system administrator canrestrict user access to specific categories

● The Validation, Verification, Leaf Access, and Limb Access categories are available to systemadministrators only

System and Stats properties typically displayed at the node level are listed in the following table.

Table 16 System and Stats Properties

System Property Definition

Node ID Numeric unique identifier for internal use

Name (Abbrev) Short, unique name

Description Description of the node

Leaf Boolean flag to define node as a leaf or limb

● If True, then node cannot have children

● If False, then node may have children

Leaf Access Indicates level of access to this node for current user (only applies if node is leaf)

Limb Access Indicates level of access to this node for current user (only applies if node is limb)

Node Approved Boolean flag to indicate that node has been in a Finalized version

Ancestor List List of ancestor nodes from parent node up

# Children Number of nodes, one level beneath

# Descendants Total number of nodes beneath (at all levels)

# Leaf Children Number of children that cannot have other children

# Leaf Descendants Number of descendants that cannot have children

# Leaf Siblings Number of siblings that cannot have children

Level Numeric level of node within hierarchy where top node level = 1

# Limb Children Number of children that may have children

# Limb Descendants Number of descendants that may have children

# Limb Siblings Number of siblings that may have children

60 Using Versions, Hierarchies, Nodes, and Properties

Page 61: DRM Manual

System Property Definition

Linked Flag indicating if the node exists in at least one other hierarchy

Links List of all other hierarchies in which the node exists (excluding current)

# Links Number of other hierarchies in which the node exists

References List of all hierarchies in which the node exists (including current)

# Siblings Number of nodes which have the same parent as this node

Property Value Scope and OriginThe property editor displays two icons to the left of each property. The first icon indicates thescope of the property and if it can inherit values.

Table 17 Property Scope Icons

Property Icon Description

Global The value of the property is constant across all hierarchies

Local The value of the property is specific to the hierarchy in which it exists

Global InheritedThe value of the property is global and inherited

Local Inherited The value of the property is local and inherited

The second icon denotes the origin of the property value.

Table 18 Property Origin Values

Property Icon Description

DefaultThe value of the property is defined by a default value (as set by the system administrator.) Defaultvalues are used when:

● the property is non-inheriting and a user has not entered a value

● the property is inheriting and no ancestor value was found

Inherited The value of the property is being supplied by an ancestor node. (The name of the ancestor nodeand the hierarchy from which the inherited value originates is displayed in the Status column ofthe Property window.)

Overridden The value of the property was set by a user at this specific node

Derived The value of the property is derived from other values

Locked The value of the property has been locked which means that it cannot be changed in any descendantnode that inherits this property's value.

Working with Properties 61

Page 62: DRM Manual

Property Icon Description

If this property value is viewed in a descendant node, its status is indicated with the lightning bolticon for Static.

Static The value of the property has been inherited from an ancestor node, whose value has been locked:

● As a result, the value cannot be changed in the descendant node

● The name of the ancestor node and the hierarchy from which the inherited value originates isshown in the Status column of the Property window

Property StatusThe Property Status column in the Property Editor provides the name of the ancestor node andthe hierarchy in which an inherited value originates. When editing properties, this column alsodisplays status messages that reflect how a value has been edited. The following table describesproperty statuses.

Table 19 Property Status

Property status Definition

[Modified] The value has been modified.

[Removed] The value has been removed - only applicable to Overridden property values.

[Locked] The classification of the property has been changed to Locked (i.e. the value cannot be changedin any descendant node that inherits the property.)

[Unlocked] The classification of the property has been changed to Unlocked (i.e. the value can be changed inany descendant node that inherits the property.)

[Cleared] A request has been made to Clear All Below for the selected property (i.e. clears the value on alldescendant nodes which have overridden their inherited values.)

Updating Property ValuesProperty names displayed in a bold font may be edited. Property names in regular text are notavailable for change.

The value of a property cannot be edited if any of the following conditions exist:

● The property has a derived value. For example, a property indicating the total number ofchild nodes are derived by Data Relationship Management and cannot be edited.

● The user does not have appropriate security rights to edit the value.

● The value of the property has been inherited from an ancestor node, whose value has beenLocked.

➤ To find a specific property:

1 Right-click in the property values area and select Find Property.

2 Select a property from the list and click OK.

62 Using Versions, Hierarchies, Nodes, and Properties

Page 63: DRM Manual

The editor opens to the selected property.

➤ To find a specific property category, right-click in the category tabs area and select Go to Tab.

Local Security for Global Properties

You use two system preferences — GlobalPropLocalSecurity and GlobalPropLocalOverride —to control local security on global properties. In the following example, note that L1 is in bothhierarchies. Assume that L1 has global property GP.

H1

A

B

L1

L2

H2

Y

Z

L1

L3

If a user is given full access from the top of H1 and read-only access from the top of H2, thenthe user cannot go to L1 under H2 and edit it. However the user can go to L1 under H1 and editit and the change to the global property can be seen on L1 under H2. This is the normal operationwhen GlobalPropLocalSecurity is false.

When GlobalPropLocalSecurity is true and GlobalPropLocalOverride is blank then the changesto GP for L1 in H1 cannot be saved because it fails the local security check (the user does nothave edit access in another hierarchy).

However if GlobalPropLocalOverride is set with global property GP, then in the above situationthe global property GP is excluded from the local security check and the user is able to save thechanges to L1 in H1

Removing Property Values

➤ To remove a value from a property, right-click the property and select Remove Value.

This removes the entered value and enables the inherited or default value to replace it.

Removing DuplicatesFor a normal, defined property, Remove Duplicates removes any value equal to the default valuein the selected node and any of its children.

Working with Properties 63

Page 64: DRM Manual

For an inheriting property, this option removes any value equal to the inherited value in theselected node and in any of its children.

For a read/write derived property, this option removes any value equal to the derived value inthe selected node and any of its children.

Remove Duplicates is also available from the Action Menu of the Version control window, if ahierarchy is selected. In this case, a dialog box enables the user to select the version, hierarchy,and properties to acted upon.

Clearing All Descendant Values

➤ To clear the (overridden) value of a property in all descendant nodes, right-click the propertyand select Clear All Below.

The value of this property in all descendant nodes is replaced using the inheritance rules.

A typical use of this feature is to clear the values of a property in all descendent nodes, inpreparation for setting and locking a new value that cannot be subsequently changed in thedescendent nodes (for example, the property appears classified as Static in the descendantnodes.)

Locking Property ValuesIf a property is classified as inheriting a user can lock the value. This action disables any changesto that value in inheriting descendant nodes.

➤ To lock a property value, do the following:

1 Set the value of the property in the selected node.

2 Right-click the property and select Lock.

A padlock icon is displayed to the left of the property name. For all affected descendant nodes,a lighting bolt icon is displayed indicating the property is static.

Note that if prior to applying the Lock, a descendant had overridden its inherited value, the Lockdoes not affect that descendant. To affect all descendants with the Lock command, use the ClearAll Below option before applying the Lock.

Saving Changes to a Property ValueTo save changes to any property values, click Save at the bottom of the Property Editor. TheSave button is not available until a change to a property value has been made.

To exit the Property Editor without saving any changes, click Close. When you are prompted tosave your changes, click No.

64 Using Versions, Hierarchies, Nodes, and Properties

Page 65: DRM Manual

Version and Hierarchy PropertiesHierarchy properties are defined at the hierarchy level and are the same for all nodes in thehierarchy. By definition, hierarchy properties are always local, defined properties.

Table 20 Hierarchy Properties

Hierarchy Property Definition

Hier ID Unique, internal identifier for the hierarchy

Hier Name Hierarchy name

Hier Descr Hierarchy description

HierarchyNodeType Points to the node-level property that is used to determine if a specified node is a certainNode Type

Hier Sort Shows property currently used for sorting the hierarchy

Hier Sort Order Integer value to allow sorting the order in which hierarchies appear within the version

Hier System Category Indicates the System Category (folder) to which this hierarchy belongs, if any

DefaultDisplayBy Default for displaying nodes within the hierarchy

Default Synchronize By Default property by which to synchronize nodes for the current hierarchy.

PrefillLeafProp Points to the node-level property that is used to pre-fill node name when creating new leafnode

PrefillLimbProp Points to the node-level property that is used to pre-fill node name when creating new limbnode

StandardHierSort Points to a node-level property to determine default sort order within the hierarchy

Top Node Name of the top node for the hierarchy

Top Node ID Node ID of the top node

UserDisplayBy Determines how hierarchy nodes display for the current user

User Synchronize By Property by which to synchronize nodes in the selected hierarchy for the current user

UserHierSort Points to a node-level property to determine sort order within the hierarchy for the currentuser

UserHierFilter Determines how hierarchy is filtered for the current user

Version properties are defined at the version level and are the same for all nodes in all hierarchies.By definition, version properties are always global, defined properties. Version properties arerarely used. Examples include the version name, description, and status.

Working with Properties 65

Page 66: DRM Manual

User-Defined Version and Hierarchy PropertiesUser-defined properties can be established at both the hierarchy and version levels. Thus, versionand hierarchy properties can have different values for different users for the same property.

SecuritySecurity provides a brief overview of the security mechanisms within Data RelationshipManagement. For complete details, refer to the Oracle Hyperion Data Relationship ManagementN-tier Administrator's Guide.

All Data Relationship Management users require a username and password. There are fouradditional factors that affect the security access of a user in Data Relationship Management:

● Assignment of a user as a Data Relationship Management administrator (either system,functional, or security administrator).

● Version status

● For non-administrator type users, assignment of a user to node access groups

● For non-administrator type users, assignment of a user to property categories

Users with questions about their access privileges to Data Relationship Management shouldcontact their Data Relationship Management system administrator.

Administrator TypesThere are three administrative types in Data Relationship Management:

● System Administrator

● Functional Administrator

● Security Administrator

System AdministratorIf the user is designated as a system administrator, the user can perform all tasks in DataRelationship Management.

The privileges of system administrators include the ability to:

● Perform exports from any version

● Edit submitted versions

● Assign security

● Assign validations and verifications

● Edit metadata including property definitions, users, validations, and verifications

66 Using Versions, Hierarchies, Nodes, and Properties

Page 67: DRM Manual

Functional AdministratorIf the user is designated as a Functional Administrator, the user can perform all tasks in DataRelationship Management and edit lookup and lists tables for properties from the Admin menu.

The privileges of functional administrators include the ability to:

● Perform exports from any version

● Edit submitted versions

● Assign security

● Assign validations and verifications

● Edit property lookup and list tables from the Admin menu

Security AdministratorIf the user is designated as a security administrator, the user can only create users and assignusers to node access groups and property categories

User Assignment to Property CategoriesProperty categories are groupings of properties.

● Property categories are visible to Data Relationship Management users as tabs in the propertyeditor.

● Users can be assigned to multiple property categories to control their access to thehierarchies.

User Assignment to Node Access GroupsNode access groups are used to control user access to hierarchies and nodes. Data RelationshipManagement users may be assigned to specific groups that have permissions to certain nodeswithin Data Relationship Management. Security based upon groups is more subtle than the on-off access determined by a user's allocation to a property category, because multiple tiers ofaccess levels may be assigned to a specified group.

Security 67

Page 68: DRM Manual

68 Using Versions, Hierarchies, Nodes, and Properties

Page 69: DRM Manual

4Running Imports

In This Chapter

Import Elements... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .69

Import Sections ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .70

Starting the Import Wizard ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .70

Naming Import Versions ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .71

Configuring Section and Processing Options ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .72

Configuring Mappings ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .74

Specifying File Format Information ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .75

Configuring Duplicate Handling... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .78

Viewing Import Results .. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .80

Data Relationship Management can import data from external systems of various formats,including text files, data extracts, and other sources. An import is always performed on a new,empty version that is created as part of the import process. Thus, the user can verify that theimport ran correctly before moving the imported data into a production environment. After thedata is verified, the blender tool can be used to incorporate the new data.

Imports can be customized and saved by any Data Relationship Management user authorizedto run imports.

You use the import wizard to run imports.

Caution!

When running Imports, the regional settings of the server must be used to format date and timeinformation. For example, if the regional setting for the server specifies that date should beformatted as dd.mm.yyyy, then the data given to the import should be in that format. The Importdoes not do any date/time conversions from one format to another so if the information is notin the correct format then it will not display correctly or at all.

Import ElementsAn import consists of the elements in the following table.

Import Elements 69

Page 70: DRM Manual

Table 21 Import Structure

Import Element Description

Import Attributes of the import, such as version, error-handling settings, and filenames

Sections Information about the import, such as hierarchy, node, and relationship (Configuring a section caninclude designating section headers and delimiters)

Columns Data attributes to be imported (An Import Column is mapped to a corresponding non-read-onlyproperty in Data Relationship Management, such as name and description. Configuring a columninvolves selecting a property to populate, ordering the column, and sometimes mapping the columnto a particular set of hierarchies. If the input format is a fixed-width text file, the column widthshould also be configured.)

Import SectionsAn import can contain any or all of the following sections:

Table 22 Import Sections

Import Section Description

Version Version property values

Required column: version name

Hierarchy Structural information about each hierarchy and top node to be imported and, perhaps, hierarchyproperty values.

Required columns: hierarchy name, top node

Node Structural information about each node to be imported and, perhaps, node property values

Required column: node name

Relationship Parent-child information about each relationship to be imported and, perhaps, node property valuesfor the child in each pair.

Required columns: parent node name, child node name

Hierarchy Node Node values specific to a specified hierarchy

Required columns: hierarchy name, node name

Starting the Import Wizard

➤ To start the import wizard:

1 From the Data Relationship Management main menu, click File, then Import.

70 Running Imports

Page 71: DRM Manual

Figure 18 Import Wizard: Import Type

2 Select an import type or a saved import and click Next.

Selecting a parent import type (for example, Flat File Import) from the hierarchy creates animport of the selected type. Selecting a saved import, under an import type, retrieves the settingsfor the import and enables the user to edit and run the import.

Table 23 Import Wizard Controls

Control Description

Save and Save As Save the import to its current name or a new name

Delete Delete a saved import

Back and Next Move backward or forward through the import wizard

Run Run the import wizard

Cancel Close the wizard without saving or running imports

Naming Import Versions

➤ To name the import version:

1 For Abbrev, enter a name.

Naming Import Versions 71

Page 72: DRM Manual

Figure 19 Import Wizard: Version and Output Options

2 For Description, enter a description.

3 For Log Output File Name, enter a path and file name for logging error and status messages.

4 Optional: In Max Errors, enter an integer value for the maximum number of errors permitted before theimport process is stopped.

The default value is 20. If a value of zero is entered, the import engine runs to completionregardless of the number of errors encountered. In the event of an unrecoverable error, theimport stops processing.

5 Click Next.

Configuring Section and Processing Options

➤ To configure section and processing options:

1 Under Sections, select each section to import.

If a section is not selected, it is not imported, even if it is displayed in the input source.

72 Running Imports

Page 73: DRM Manual

Figure 20 Import Wizard—Section and Processing Options

2 Optional: Under Skip Blank Values for these Properties, select a property type to skip blank, source-filevalues in for the selected property types.

3 Optional: Under Skip Default Values for, select a property type to skip source-file values that equal thedefault value for the selected property.

4 Optional: Select Determine Leaf Nodes At End of Import Process to specify that, at the end of the importprocess, the import automatically sets the leaf property to True for any node that has no children.

If this option is not selected, the leaf property retains its system default value or any valueexplicitly included as part of the imported data.

5 Optional: Under Relationship Section Sorting, select Sort Relationships to enable the import to sort thenodes based on the order in which they are displayed in the relationship section of the source file, andcomplete both of the following actions:

● From Sort Property to Populate, select the node property in which to store the sort order

● For Hierarchy to be Sorted, enter the hierarchies to which to apply the sort

6 Click Next.

Configuring Section and Processing Options 73

Page 74: DRM Manual

Configuring MappingsYou configure columns on the Mappings page of the import wizard.

➤ To configure mappings:

1 From Section on the Mappings page, select a section.

Figure 21 Import Wizard: Mappings

2 Optional: From Category, select a filter to limit the Available Properties list by type.

3 In Available Properties, double-click an item to add it to the Selected Properties list.

A special column called Ignore Column is available as a placeholder for any column in the inputsource that should not be processed during the import.

Note:

A column listed in bold is a required column and cannot be removed.

4 Use the up and down arrows to position the column in the Selected Properties list.

The first item in the list is the first column, the second item in the list is the second column, andso on.

74 Running Imports

Page 75: DRM Manual

5 Optional: To map a column to one or more hierarchies, click Hierarchy List.

This feature applies only to hierarchy-specific (or local) properties.

To edit the hierarchy list:

● In the list box, enter the name of each hierarchy to which the current column applies. Theproperty value is set only in the hierarchies designated in the list.

● Optional: Select Assign to All if values in that column should be applied to all hierarchies.By default, Assign to All is set to true.

● Click OK to save the hierarchy list values or Cancel to exit without saving.

6 Click Next.

Specifying File Format InformationWhen you edit or create a flat file import, a modified Section and Processing Options page isdisplayed. The primary required entry on this page is the file name for the import file.

➤ To specify file format information:

1 In the File Name text box, enter the file path and file name of the flat file to import.

You can click on the folder button to browse.

Specifying File Format Information 75

Page 76: DRM Manual

Figure 22 Import Wizard: Text File Format

2 Under File Format, select a file formats:

● Fixed Width

a. Click to display the Fixed Width Configuration dialog box.

76 Running Imports

Page 77: DRM Manual

Figure 23 Fixed Width Configuration Dialog Box

b. From Section, select a file section.

c. From Columns, select a column.

d. In Column Width, enter the width for the selected column.

Each column name in the list identifies the number of spaces that the column occupies inthe input text file.

e. Repeat steps b, c, and d until you have set the width for each column in each section.

f. Click OK.

● Delimited

g. From the drop-down list, select a delimiter (comma, tab, or other).

h. If you select Other, enter the delimiter character.

3 Optional: Select Strip Quoted Strings to remove quotation marks during data import.

Note:

The string must be enclosed in single quotation marks ( ' ) to be removed. If the string is enclosedin double quotation marks ( “ ) the quotation marks are not removed.

Selecting this option removes primary quotation marks and converts quotation marksembedded within quotation marks to primary quotation marks before importing the value.

For example:

'Mr. Harris's Necktie'

is imported as:

Mr. Harris's Necktie.

4 Under Section Headings, enter the delimiter prefix.

Specifying File Format Information 77

Page 78: DRM Manual

The delimiter prefix is a character that is displayed at the beginning of a section heading, suchas /, /**, or [. The delimiter suffix is optional.

5 Enter a heading for each section.

Each section has its own heading text, which, when combined with the delimiter, forms theheading.

An example of each heading is displayed on the right. For example:

Version Name[version]

6 Click Next.

Configuring Duplicate HandlingThe Duplicate Handling page enables the parameters that affect how the import processorhandles duplicate nodes. Duplicate is defined as a node that is displayed under multiple parentswithin the same hierarchy. If a duplicate is identified during the import, the name of the duplicateis replaced with a newly-created unique node name, which is defined according to the guidelinesset on the Duplicate Handling page.

As you edit the settings for handling duplicates, an example of the resulting value is displayed.Duplicate nodes can be queried to resolve underlying data issues.

➤ To set up duplicate handling:

1 Optional: For Unique String, enter a string.

The string is used to form part of the new unique node name.

78 Running Imports

Page 79: DRM Manual

Figure 24 Import Wizard: Duplicate Handling

2 For Delimiter, enter a character.

The character is used to separate the original node name from the unique portion of the name.

3 For Unique ID Seed, specify a starting point for this ID.

For example, if NodeA occurs three times in a hierarchy and the unique ID seed is 1, the originalnode is not changed, and the other node names are replaced with NodeA1 and NodeA2. Thisexample ignores the other Duplicate settings in order to illustrate the use of unique ID seed.

4 For Zero-pad Length, enter the minimum number of digits required in the unique ID portion of the duplicatename.

For example, a value of 3 for zero-pad length produces duplicate nodes named NodeA001,NodeA002, and so on.

5 Optional: Select Append unique text to the end of the Node Abbrev to append the unique portion of thename to the end of the original node name.

● If this option is selected, the unique portion of the name is added to the end of the originalnode name.

● If this option is not selected, the unique portion of the name is prefixed to the beginning.For example, 001NodeA, 002NodeA.

Configuring Duplicate Handling 79

Page 80: DRM Manual

6 From Associated Property, select a property to enable duplicate nodes to be grouped so they can be easilyqueried after the import is complete.

If an associated property is set, the property is populated with the node name of the originalnode in all duplicate nodes, and is a global, associated node property.

7 From Duplicate Error Mode, select a mode to determine the severity with which the import processor treatsa duplicate:

● Generate Warning — A warning message is added to the log for each duplicate.

● Generate Error — The processor adds an error message is added to the log.

Note:

Processing stops if the number of errors exceeds the Max Errors value.

8 Click Run.

Viewing Import ResultsAfter an import is complete, the Import Results dialog box is displayed. This dialog box displaysstatistical information about the import and a detail of each message generated during the importprocess. If a log output file name was designated during definition of the import, the informationin the Import Results dialog box is contained in the output file.

Data is imported to a newly-created version in a detached state. Thus, the data is not yetpermanently saved. After the imported data is verified, it can be saved by right-clicking theversion in the Version control window.

80 Running Imports

Page 81: DRM Manual

Figure 25 Import Results

Viewing Import Results 81

Page 82: DRM Manual

82 Running Imports

Page 83: DRM Manual

5Using Automator

In This Chapter

Performing Automator Imports.. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .83

Automator File Format .. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .86

Supported Automator Actions ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .87

Required Automator Parameters .. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .89

Performing Automator ImportsAutomator is designed to enable Data Relationship Management users to make bulk hierarchychanges that are defined in a flat file format. The functions supported are typical node andproperty manipulations. When Automator is used, the changes defined as rows in the flat filecan be performed automatically.

The Automator functions by reading rows from the specified flat file. Each flat file row definesan action to be taken to modify Data Relationship Management hierarchies. Each row is readand the appropriate actions are performed sequentially. If any errors are encountered, a statusmessage is displayed in the Automator window.

Caution!

When using the Automator, the regional settings of the server must be used to format date andtime information. For example, if the regional setting for the server specifies that date shouldbe formatted as dd.mm.yyyy, then the data given to the Automator should be in that format.The Automator does not do any date/time conversions from one format to another so if theinformation is not in the correct format then it will not display correctly or at all.

➤ The following steps must be followed to perform an Automator batch process:

1 Create a flat file containing the actions to be performed. Detailed definitions of the flat file format are listedbelow.

2 Run the Automator from within Data Relationship Management.

3 Check for the failure of any specified actions and the associated error messages.

Performing Automator Imports 83

Page 84: DRM Manual

Running Automator

➤ To access Automator from Data Relationship Management:

1 From the Data Relationship Management main menu, select File, then Automator.

2 Under Script File, enter the name and path for the file and configure any file options as necessary.

Click and select a flat file containing the actions to be taken.

3 Click Load to load the flat file contents into the window.

It may take a few seconds to parse and load the flat file. The actions defined in the flat file arenow listed in the Automator Window. If any of the actions defined in the flat file do not havethe appropriate number of parameters, an error message is displayed in the Return Value columnof the window, and any action names that are not recognized by the Automator are ignored,and are not listed.

84 Using Automator

Page 85: DRM Manual

Figure 26 Loaded Automator Window

The list of actions (and their associated parameters) defined in the flat file may now be reviewed.If necessary, the check box adjacent to each Action Name on the list of actions may be clickedto exclude or include defined actions. The Select All, Check, Uncheck and Toggle buttons maybe used to define the actions that are included or ignored when the automator list is processed.

4 If necessary, click Versions to map a version name to another existing version.

In the Automator Version Substitution dialog box, the Original list displays versions in theAutomator file. The Substitute list displays versions in the system.

Note:

You can type the version name into the Substitute text box.

Performing Automator Imports 85

Page 86: DRM Manual

Figure 27 Automator Version Substitution Dialog Box

5 Click the Process button to perform the automator process. The process is performed immediately.

6 Actions are implemented by Data Relationship Management in the order in which they are defined on thelist in the Automator Window.

The status of each action (e.g. “Unprocessed”, “Failure” or “Success”) can be monitored in theStatus column, and the progress of large processing lists are displayed in a progress bar.

7 The results of any actions having a returned value are displayed in the Return Value column.

Reviewing Automator Processing ErrorsWhen the processing of the automator is complete, the Automator Window may be reviewedfor any errors. The Status column displays “Failure” for any errors, and a relevant error messageis listed in the Return Value column.

● If required, the Status and Return Value columns can be added to the original flat file (theybecome columns G and H of the file) by clicking on the Save button.

● Alternatively, a new flat file can be created (including these columns) by clicking Save As.In this case, you are prompted to define an appropriate file name. The resulting flat file canbe examined and changes can be made to the rows that resulted in error messages. The flatfile can then be resubmitted to the Automator for processing of the corrected rows.

Automator File FormatThe Data Relationship Management Automator processes data from a flat file whose format canbe specified by clicking the Options... button to display the Automator Flat File Script dialogbox.

86 Using Automator

Page 87: DRM Manual

Figure 28 Automator Flat File Script

In the Column Order field, the order in which the 6 required columns appear in the flat file canbe modified. The type of column Delimiter (comma, tab, or other) can be set. The option toStrip Quoted Strings can also be enabled. Clicking the Defaults button resets all options to thedefault setting. Clicking OK saves the desired options and closes the dialog box.

The data in the flat file must follow a simple, but precise, format.

● The first column of the flat file (column A) must contain the name of the Automator actionthat is to be performed. If this column does not contain a recognized action, then the rowis ignored and not loaded. Note that a Remark action is available to allow comments to beadded to the flat file.

● The remaining columns of the flat file contain a list of parameters that define each action.Typically, for most Automator actions, the first three columns of parameters (columns B,C and D) contain the names of the Data Relationship Management version, hierarchy andnode upon which the action is to be performed. Columns E and F show other parametersrelevant to each action.

● Columns G and H of the flat file can be populated by Data Relationship Management withthe status and any comments resulting from the performance of the specified actions, if theappropriate command is selected in the Automator Window. In such cases, column Greports “Success” or “Failure”, and column H reports the reasons for any failures.

● Your Data Relationship Management system administrator should have an exampleAutomator flat file template that can be examined and copied to clarify the required format.If necessary, this template can be requested directly from your Oracle representative.

Supported Automator ActionsThe Automator supports the actions in the following table.

Supported Automator Actions 87

Page 88: DRM Manual

Table 24 Automator Actions

Action Purpose

Rem Indicates a remark/comment row in the flat file (Any arbitrary text can be entered onother columns of this row for documentation purposes—it is ignored by the Automatorprocess)

Add Adds the specified node to the specified hierarchy (This action can only be used for anode that does not already exist within the specified version)

Insert Inserts the specified node into the specified hierarchy (This action can only be used fornodes that already exist in another hierarchy within the specified version)

AddInsert Adds the specified node if it does not already exist in the specified version, otherwisethe node is inserted

Delete Deletes the specified node from the version, and merges it with the merge node if oneis specified

Destroy Destroys the specified node from the version

Activate Activates the specified node in the hierarchy

Inactivate Inactivates the specified node in the hierarchy, and merges it with the merge node if oneis specified

Remove Removes the specified node from the hierarchy

Move Moves the specified node within the hierarchy

Annul Annuls the specified node

AnnulAllBelow Annuls all nodes following the specified node

ChangeProp Updates the value of the specified property of the specified node

RemoveProp Removes (clears) the value of the specified property of the specified node (The propertyitself is not deleted because many other nodes may be utilizing this property)

RemoveDupProps Removes (clears) duplicate properties for the specified node (Corresponds to theRemove Duplicates command that is available to users within Data RelationshipManagement)

ClearPropsBelow Clears the values of the specified property in all of specified node’s children (Correspondsto the Clear All Below command that is available to users within Data RelationshipManagement)

LockProp Locks or unlocks the specified property of the specified node

PropQuery Returns the value of the specified property of the specified node in the Automator resultset

PropCompare Returns True if the value of the specified property of the specified node is equal to thevalue listed in the flat file, otherwise returns False

NodeExists Returns True if the specified node exists in the specified version, otherwise returns False

88 Using Automator

Page 89: DRM Manual

Action Purpose

NodeExistsInHier Returns True if the specified node exists in the specified hierarchy, otherwise returnsFalse

NodeHasAsParent Returns True if the specified parent node is the parent of the specified node, otherwisereturns False

UpdateVersion PropValue Updates the value of a version property

RemoveVersion PropValue Removes (clears) the value of a version property

AssignVersion Validations Assigns validations/verifications at the version level

AddOrphan Adds an orphan node to a version

AddHier Adds a hierarchy to a version

DeleteHier Deletes a hierarchy from a version

ChangeHierTopNode Changes the top node for a specified hierarchy

UpdateHier PropValue Updates the value of a hierarchy property

RemoveHier PropValue Removes (clears) the value of a hierarchy property

AssignHier Validations Assigns validations/verifications at the hierarchy level

DeleteOrphan Deletes an orphan node

Required Automator ParametersThe parameters required by each action in each flat file column are as follows:

Table 25 Automator Parameters

Column A Column B Column C Column D Column E Column F

Rem Remark Remark Remark Remark Remark

Add Version Hierarchy Node Parent node Is a leaf(0=false,1=true)

Insert Version Hierarchy Node Parent node

AddInsert Version Hierarchy Node Parent node Is a leaf(0=false,1=true)

Delete Version Hierarchy Node (Merge node)

Destroy Version Hierarchy Node

Activate Version Hierarchy Node

Required Automator Parameters 89

Page 90: DRM Manual

Column A Column B Column C Column D Column E Column F

Inactivate Version Hierarchy Node (Merge node)

Remove Version Hierarchy Node

Move Version Hierarchy Node Destinationparent node

Annul Version Hierarchy Node

AnnulAllBelow Version Hierarchy Node

ChangeProp Version Hierarchy Node Property label Value

RemoveProp Version Hierarchy Node Property label

RemoveDupProps Version Hierarchy Node Property label

ClearPropsBelow Version Hierarchy Node Property label

LockProp Version Hierarchy Node Property label Is Locked(0=false,1=true)

PropQuery Version Hierarchy Node Property label

PropCompare Version Hierarchy Node Property label Value

NodeExists Version Node

NodeExistsInHier Version Hierarchy Node

NodeHasAsParent Version Hierarchy Node Parent node

UpdateVersionPropValue

Version Property label Value

RemoveVersionPropValue

Version Property label

AssignVersionValidations

Version Validation

AddOrphan Version Node Is a leaf (0=false,1=true)

AddHier Version Hierarchy Description Top Node

DeleteHier Version Hierarchy

ChangeHierTop Node Version Hierarchy New Top Node

UpdateHier PropValue Version Hierarchy Property label Value

RemoveHier PropValue Version Hierarchy Property label

AssignHier Validations Version Hierarchy Validation

90 Using Automator

Page 91: DRM Manual

Column A Column B Column C Column D Column E Column F

Delete Orphan Version Node

Required Automator Parameters 91

Page 92: DRM Manual

92 Using Automator

Page 93: DRM Manual

6Using Blender

In This Chapter

Blender Elements ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .93

Using the Blender Wizard ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .94

Configuring Blender Versions and Hierarchies ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .95

Configuring Top Nodes ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .98

Viewing Blender Results .. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 102

Blender enables various elements of two versions to be combined, or blended, together. Theelements to be blended can include various combinations of structural elements, such ashierarchies and nodes, and properties.

Blender provides these options:

● To process any combination of adds, moves, or deletes

● To act upon any combination of hierarchies

● To map top nodes from a source hierarchy to nodes in a target hierarchy

Blenders can be customized and saved by System Administrators or Functional Administrators.

Blender ElementsA blender consists of the elements described in the following table.

Table 26 Blender Structure

Blender Element Description

Blender These are attributes of the Blender itself, such as what versions are being blended, defaultvalues, etc.

Source/Target Version These are the two versions being blended. Blending can occur from the source directly intothe target, or into a third new version that is created during the blend process.

Hierarchy Sets Also called hierarchy/top-node pairs. These are mappings from the source to the targetindicating which hierarchy top nodes in the target are to receive values from the source. Topnodes in the target can either be created on the fly, or mapped directly to existing top nodes,depending on the Blender settings.

Property Sets Lists of properties to be blended. Properties can be blended in one of three ways:

Blender Elements 93

Page 94: DRM Manual

Blender Element Description

● All

● None

● Selected

If Selected is chosen, then the selected property set determines which properties areblended.

Using the Blender WizardYou use the blender wizard to run blenders. The wizard enables you to set the source and targetversion, set options for hierarchy-level blending behavior, copy blended values to a new version,and so on.

Table 27 describes the controls in the Blender wizard.

Table 27 Blender Wizard Controls

Blender Wizard Controls Description

Save and Save As Allow the blender to be saved under its current name, or a new name

Delete Delete a previously saved blender

Back and Next Move forwards and backwards through the import blender dialog box

Cancel Close the dialog box without saving or running any blender

➤ To run a blender:

1 From the Data Relationship Management main menu, select File, then Blender.

Figure 29 Blender Dialog Box—Choose Blender

94 Using Blender

Page 95: DRM Manual

2 Select a new or saved a blender.

Selecting [New Blender] from the tree view creates a blender. Selecting a previously saved blenderretrieves the settings for that blender and enables you to edit and run the blender.

3 Click Next.

Configuring Blender Versions and Hierarchies

➤ To set the version and hierarchy for a blender:

1 In Source, select the source version.

Figure 30 Blender Dialog Box - Version/Hierarchy Settings

2 In Target, select the target version.

3 Optional: Select Copy to New Version to specify that the blended values be stored in a new version ratherthan in the target version.

Configuring Blender Versions and Hierarchies 95

Page 96: DRM Manual

If blending to a new version, an Abbrev is required to name the version. A description for thenew version is optional.

4 Selecting Apply to All Hierarchies applies the default settings to all hierarchy/top-node pairs; otherwisethe same settings can be made for each pair.

Default values for hierarchy/top-node settings are required.

5 From the Property Select Options drop-down list, select one of the following ways to blend properties:

● All Excl Val/Ver/Access — all properties are blended; excludes properties used for node-level validation and verification assignments and for node access group leaf and limb-levelsettings.

● None — no properties are blended

● Selected — the selected properties are blended

a. To select properties, click .

Figure 31 Select Properties Dialog Box

b. Select properties to be included in the blend process.

c. Optional: From the Propagate Mode drop-down list, select one of the following modes todetermine how the property is populated in the target:

● Force - the property is assigned for every node in the target, whether that property isdefined at that node, or is inherited, read/write inherited, and so on.

● Difference - populates the property for any node where the value is different, regardlessof how that property is populated in the target.

● Defined - the property is blended only when it is specifically defined for the node inthe source.

96 Using Blender

Page 97: DRM Manual

d. Select Propagate Property Locks if you want locks in the source to be blended to the target.

e. Click OK.

6 Select from the following options:

● Allow Hierarchy Creation to create hierarchies in the target version that exists only in thesource version

Note:

If this option is not selected and there are hierarchies that exist in the source but not in thetarget, then an error occurs.

● Allow Leaf Promotion to promote a node in the source that contains children to a limb inthe target

Note:

If a node in the source has children, but its corresponding node in the target is a leaf node(an outermost node with no children allowed), then this option enables the Blender topromote the node to limb status. The child nodes from the source are then added to thelimb node in the target.

● Process Activations to process node activations (inactivate and reactivate) from the targetto the source

● Process Hier Val/Ver Assignment to process the hierarchy level validation and verificationassignments from the target to the source

● Process Moves to move any node which has a different parent in the source to that parentin the target

● Process Adds to add any nodes existing only in the source to the target

● Process Removes to remove any nodes existing only in the target according to the settingin the Remove Mode drop-down list and the Remove Indicator drop-down list.

If you selected Process Removes, select one of the following Remove Modes:

❍ Remove - node is immediately removed during blending

❍ Mark - node is marked for later removal

When the Remove Mode is set to Mark, the Remove Indicator field designates whichproperty contains the value showing that the node is flagged to be removed.

The remove indicator property must be created as a local, Boolean property. Forinformation on creating properties, see the Oracle Hyperion Data RelationshipManagement N-tier Administrator's Guide.

7 Click Next.

Configuring Blender Versions and Hierarchies 97

Page 98: DRM Manual

Configuring Top NodesFrom the Hierarchy/Top-Node Settings page of the blender wizard, you can edit settings thatare specific to each set of hierarchy/top-node pairs.

➤ To configure top nodes:

1 Optional: Select Blend All Hierarchies to blend all hierarchies using the defaults from the Blender.

If you select the Blend All Hierarchies option, no other options on this tab are enabled.

Figure 32 Blender Dialog Box—Hierarchy/Top-Node Settings

2 Select a top-node pair and click one of the following options:

● New - to add a new hierarchy set

● Edit - to edit a hierarchy set

● Delete - to delete the selected hierarchy set.

3 Click the arrow buttons next to the hierarchy/top-node list to change the position of a hierarchy set withinthe list.

98 Using Blender

Page 99: DRM Manual

This controls the order in which sets are processed.

4 Optional: Select Hierarchy/Top Node Settings.

● Select Use Blender Defaults if you selected Apply to all Hierarchies on the previous page,and default values from the Version/Hierarchy Settings page are used and the correspondingoptions in this section are not enabled. Skip step 5.

● If you deselect Use Blender Defaults, you will need to perform step 5.

5 From the Property Select Options drop-down list, select one of the following ways to blend properties:

● All Excl Val/Ver/Access — all properties are blended; excludes properties used for node-level validation and verification assignments and for node access group leaf and limb-levelsettings.

● None — no properties are blended

● Selected — the selected properties are blended

a. To select properties, click [...] next to the Property Select Options drop-down list.

b. Select properties to be included in the blend process.

c. Optional: From the Propagate Mode drop-down list, select one of the following modes todetermine how the property is populated in the target:

● Force - the property is assigned for every node in the target, whether that property isdefined at that node, or is inherited, read/write inherited, and so on.

● Difference - populates the property for any node where the value is different, regardlessof how that property is populated in the target.

● Defined - the property is blended only when it is specifically defined for the node inthe source.

d. Select Propagate Property Locks if you want locks in the source to be blended to the target.

e. Click OK.

6 Optional: Select one or all of the following options:

● Process Activations to process node activations (inactivate and reactivate) from the targetto the source

● Process Hier Val/Ver Assignment to process the hierarchy level validation and verificationassignments from the target to the source

● Process Moves — causes any node which has a different parent in the source to be movedto that parent in the target.

● Process Adds — causes any nodes existing only in the source to be added to the target.

● Process Removes — causes any nodes existing only in the target to be removed accordingto the setting in the Remove Mode drop-down list and the Remove Indicator drop-downlist.

If you selected Process Removes, select one of the following Remove Modes:

❍ Remove - the node is immediately removed during blending.

❍ Mark - the node is marked for later removal at the user’s discretion.

Configuring Top Nodes 99

Page 100: DRM Manual

When the Remove Mode is set to Mark, the Remove Indicator field designates whichproperty contains the value showing that the node is flagged to be removed.

The remove indicator property must be created as a local, Boolean property. Forinformation on creating properties, see the Oracle Hyperion Data RelationshipManagement N-tier Administrator's Guide.

7 If opened from the Hierarchy/Top Node Settings page, the Blender Hierarchy Set dialog box enables thematching of Hierarchy Sets from the Source to the Target Version.

Figure 33 Blender Hierarchy Set Dialog Box

8 Use next to the Source Top Node box to browse through the Source version and to select a hierarchyand Top Node.

9 Select a Target option:

● If the Target Use Same as Source option is checked, then the target node editors and buttonsare disabled and the blender uses the same node in both the Source and Target.

● Otherwise, click to browse through the target version and select a hierarchy and topnode. If the Allow Hierarchy Creation option for the blender is true, then the Target textboxes are enabled and can be used to enter new values for hierarchy and top node.

10 The Blender Options page shows general processing options for the blender.

100 Using Blender

Page 101: DRM Manual

Figure 34 Blender Dialog Box - Blender Options

11 Under Max Iterations, enter a number.

The Max Iterations value determines the maximum number of attempts the Blender performsin reconciling the Source and Target versions. This prevents the Blender from runningindefinitely in the case of irresolvable conflicts. The recommended value is 3.

12 Under Max Errors, enter a number.

The Max Errors value sets the maximum number of errors that can occur during processingbefore the Blender aborts.

13 Select a Propagate Mode.

The default Propagate Mode determines how each property is populated in the Target. Thepossible values are Force, Difference and Defined.

● In Force mode, the property is assigned for every node in the Target, whether that propertyis defined at that node, or is inherited, read/write inherited, etc.

● Difference mode populates the property for any node where the value is different, againregardless of how that property is populated in the Target.

Configuring Top Nodes 101

Page 102: DRM Manual

● In Defined mode, the property is blended only when it is specifically defined for the nodein the Source. The default option to Propagate Property locks determines whether locks inthe Source are blended to the Target.

14 Select any of the following options:

● Propagate Property Locks — to blend property locks from the source to the target

● Disable Real-Time Validations — to turn off the real-time validations on the target versionprior to performing the blend operation

● Process Version Level Val/Ver Assignments — to process version-level validation andverification assignments from the target to the source

15 Click [...] to select a file in which to store the output log for the Blender.

16 Select any of these options:

● Clear Values to set all Blender Status Property values to False during processing.

● Populate Values to set each Blender Status Property to True during processing.

● Select specific Blender Status Property option from the drop-down lists.

❍ Version Blended Property — The name of the property that will be set to TRUE if theversion has been blended {Version Level Boolean Defined Property}

❍ Hierarchy Blended Property — The name of the property that will be set to TRUE if thehierarchy has been blended {Hierarchy Level Boolean Defined Property}

❍ Node Created Property — The name of the property that will be set to TRUE if the nodewas created by the blend {Global Node Level Boolean Defined Property}

❍ Node Inserted Property — The name of the property that will be set to TRUE if the nodewas inserted by the blend {Local Node Level Boolean Defined Property}

❍ Node Moved Property — The name of the property that will be set to TRUE if the nodewas moved by the blend {Local Node Level Boolean Defined Property}

❍ Global Node Changed Property — The name of the property that will be set to TRUEif the node had global properties changed by the blend {Global Node Level BooleanDefined Property}

❍ Local Node Changed Property — The name of the property that will be set to TRUE ifthe node had local properties changed by the blend {Local Node Level Boolean DefinedProperty}

❍ Leaf Promoted Property — The name of the property that will be set to TRUE if thenode was promoted from a leaf to a limb by the blend {Global Node Level BooleanDefined Property}

17 After all settings have been configured, click Run to process the blender.

Viewing Blender ResultsAfter a blender is complete, the Blender Results dialog box is displayed.

102 Using Blender

Page 103: DRM Manual

Figure 35 Blender Results

This dialog box displays an error count and status and a list of each message generated duringthe Blender process.

If the Copy to New Version option was selected, then the newly-created version that containsthe blended data is in a Detached state. This means that the data has not yet been permanentlysaved. After the blended data is verified, it can be saved by right-clicking on the version in theVersion Control Window.

Viewing Blender Results 103

Page 104: DRM Manual

104 Using Blender

Page 105: DRM Manual

7Running Exports

In This Chapter

Export Classes... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 105

Starting the Export Wizard... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 106

Using Export Books ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 133

Customized export types may be available for certain clients, for example, XYZ CorporationEssbase Account Export. Such exports may use standard Export/Report dialog box pages and haveadditional customized dialog box pages, documented separately. Please contact your Oraclerepresentative for details about customized export types for your organization.

Export ClassesData Relationship Management has many different export classes that can be used in exportingthe data in different formats to external systems. Some of these classes are for general use whileothers are for very specific purposes. The exports are flexible in allowing the user to specify thecontent, filtering, formatting and output location. Understanding the classes will assist indetermining the correct way to get the data out of Data Relationship Management.

The following table lists the main export classes for Data Relationship Management.

Note:

Some clients may have more classes since they have custom export classes for their specificimplementation.

Class Description Usage Frequency Database Export

Ancestor Export Deprecated - functionality is replaced by the Generation Export class Low - Deprecated No

Generation Export Create a generation-based or level-based export. In addition, it has theability to balance the hierarchy by different mechanisms. Can be used tosend hierarchies out to an external system in a generational or level-basedformat.

Medium No

Compare Export Produces comparison results between two hierarchies. They can be thesame hierarchy in different versions giving a “what has changed” type ofexport. They can be different hierarchies in the same version giving a

Medium Yes

Export Classes 105

Page 106: DRM Manual

Class Description Usage Frequency Database Export

hierarchy content comparison. This kind of export can be used to sendchanges only to an external system.

Difference Report Produces reports showing differences. The main difference between thisand the Compare Export is that its format is in a more readable form ratherthan the column-based Compare Export.

Low No

Hierarchy Export This is the main export class for Data Relationship Management. Thisexport goes through the nodes in the specified hierarchies and exports arecord for each node. This is the export to use to create a parent-child typeof export for external systems as well as a basic node list type of export.

High Yes

Lookup Export This export is a special use case and it only provides the export of a lookupset for a specified lookup property.

Low No

Merge Export This export is used to retrieve the Merge node data that is collected whenMerge is used on a Delete or Inactivate.

Low No

Property List Export This export is a special use case and it only provides the export of a listfor a specified list property.

Low No

Trans Log Export Exports the transaction history information. Medium Yes

Version Export The version export is similar to the Hierarchy export with the exceptionsthat it goes through all nodes in the version and cannot retrieve local orhierarchy level property information.

Medium Yes

Starting the Export Wizard

➤ To run an export:

1 From the Data Relationship Management main menu, select File, then Export/Report.

The Exports dialog box opens and displays the Select Export/Book page. This page is the startingpoint for all export types.

106 Running Exports

Page 107: DRM Manual

Figure 36 Select Export/Book Page

2 Select the Current Version to be used for the export. For comparison exports, a Previous Version must alsobe selected.

Click to open the Version Criteria dialog box if a Baseline or As of Version is desired.

3 Choose the desired export type.

● To create a new export, select the desired type from the tree and click the Next button.

● To run or edit an existing export, drill down the tree view under the appropriate export typeand select the desired export, then click Next. Note that standard exports created by anadministrator and available to all users are prefixed with "std:" and displayed in bold.

Depending upon the type of export being performed, the Export/Report dialog box presentsa varying series of dialog box requesting further criteria for the export. Each dialog box isdescribed in the sections that follow.

Top Nodes PageThe Top Nodes page is used in hierarchy exports to select the top nodes of the hierarchies to beexported.

Starting the Export Wizard 107

Page 108: DRM Manual

Click Add to display the Select Node menu from which a top node may be selected. Select asmany top nodes as required. When multiple nodes are added to the list, the data will be exportedin the order that the nodes appear. The arrow keys on the right can be used to reorder the currentnode list. Use Delete to remove a node from the list.

For comparison exports, the top node for both the current and previous version must be selected

Check the Include Inactive Nodes check box if inactive nodes are to be included in the export.

Figure 37 Export/Report Dialog Box—Top Nodes For Non-Comparative Exports

In the Descendants section, a text file may be defined to list nodes to be included or excludedfrom the export. To use this feature, check the Use text file to include/exclude descendant Nodescheck box and supply the appropriate file name. Select the appropriate option to determine ifthe text file contains nodes to be included or excluded. The format of the text file is just a listingof nodes with one node per line.

For comparison exports, an alternate Join property can be selected if desired. By default, thecompare operation maps nodes from each hierarchy that have the same name. It is also possibleto join nodes based on other properties. For example, if a property named SortCode was a uniquekey in the specified hierarchies, then this property is used in the Compare to identify differences/similarities between nodes having the same SortCode in each hierarchy.

108 Running Exports

Page 109: DRM Manual

Figure 38 Export—Hierarchy Compare Export Dialog Box—Top Nodes Page

Select Columns Page This page is used by nearly all export types to define the columns of data to be included in theexport. For most export types, the columns represent property values.

● Click the arrow buttons in the center of the dialog box to move values from the Availablelist to the Selected list.

● If necessary, use the Category drop down list to make navigation of the Available list easierby restricting it to a single Property Category.

● Use the up and down buttons to the right of the Selected list to change the display order ofthe selected columns

Starting the Export Wizard 109

Page 110: DRM Manual

Figure 39 Exports Dialog Box—Select Columns Page

For some export types there are additional options available.

For the Generation Hierarchy Export, the Column Set list is displayed to allow selecting columnsas:

● Pre Columns: properties to export at the beginning of each row

● Bottom Node Columns: properties for the specified bottom node

● Ancestor Columns: node properties for the ancestor list of the specified bottom node

● Post Columns: properties to export at the end of each row

The specialty columns [Node Sequence #] and [Ancestor Sequence #] are also available tonumber each row in the export.

For the Hierarchy Compare Export, properties are duplicated in the Available list and suffixedwith [From] or [To] to designate the source hierarchy of each property. The following specialtycolumns are also available in the list:

● [Action Type Code] - exports the type of action (Addition, Merge, Deletion, etc.) for eachdifference found

● [Merged Node] - the name of the merge node used during deletion

110 Running Exports

Page 111: DRM Manual

● [Property Label] - the name of the property updated

● [Property Value] - the updated value of the property

For Lookup Export, there are only two columns available because the Lookup Value and theResult Value are the only things being exported.

Figure 40 Exports—Lookup Export Dialog Box—Select Columns Page

For Merge Log Export, the available columns represent information on the merge operationsperformed.

Figure 41 Exports—Merge Log Export Dialog Box—Select Columns Page

For the Transaction Log Export, the available columns relate to Transaction History activity.

Starting the Export Wizard 111

Page 112: DRM Manual

Figure 42 Export—Trans Log Export Dialog Box—Select Columns Page

Column Options PageThis page is used by hierarchy export types to configure options for each column in the export.

● Check the Skip Defaults check box to place a blank in the export if the field value is equalto the default value.

● Check the Pivot check box if the field contains a comma delimited value. Then, for eachvalue in the list for that column, a row is exported with all other fields set to the same values.The Pivot option may be selected on just a single column.

● Check the Primary Key check box to define a field (or fields) as the primary key to be usedwhen determining if duplicates exist. This is also used by the Remove Duplicates option ofthe Parameters pages.

112 Running Exports

Page 113: DRM Manual

Figure 43 Exports—Generation Hierarchy Export Dialog Box—Column Options Page

Column Widths PageThis page appears when fixed width columns are specified for the output. For each column, thefollowing can be configured:

● Numerical value for column width - cannot be set to zero

● Justification – Left or Right

● Pad Character to pad unused character positions. Default is a space.

Figure 44 Hierarchy Export Dialog Box—Column Widths Page

Parameter PagesParameter pages capture the required additional parameters that are unique to each export type.There are many similarities and some subtle differences between these pages.

Starting the Export Wizard 113

Page 114: DRM Manual

Generation Export Parameters PageThe Generation Export Parameters page is used to select the appropriate options that definehow a Generation Hierarchy Export is generated.

Figure 45 Exports—Generation Export Dialog Box—Parameters Page

● The Node Selection Options define whether all nodes are included in the export, or justthose that are limbs or leaves.

● Select Recurse from Top Nodes if the export should include a row for all nodes below thetop node selected. If not selected, then only the selected top node is included in the export(which is typically not the desired result.)

● Select Include Implicitly Shared Nodes to include descendant nodes below shared limbnodes that have been explicitly shared. Implicit shared nodes are only exported if not filteredout by another option such as top node selection or a property query filter. The structureof implicitly shared nodes below a shared parent node is reflected in the ancestor section ofthe generation export.

❍ If the Limb Nodes Only or Leaf Nodes Only option is used, the Shared Node is includedeven if it does not match the selected option (leaf or limb). This is done since the

114 Running Exports

Page 115: DRM Manual

implicitly shared node is substituted for the explicitly shared nodes and they areprocessed against the node selection options.

❍ If a query filter is used in the export, the administrator must explicitly include the sharednodes for this option to work. For example, the filter (#Children=0) would need to bechanged to ((#Children=0 OR (Shared Node Flag = True)).

❍ For the implicitly shared node, the Parent properties will reflect the values of the actualnode, i.e. the primary node. For example, if your export includes the Parent Propertyfor an implicitly shared node, then it will show the parent as the primary node and notthe shared node.

● Select Root To Node to set the ordering of the export (if not selected, the order is Node toRoot.) For example, if node A is a parent to node B and this option is selected, then theoutput is A,B. Otherwise, with this box unchecked, it is B,A.

The Repeat Level Options are typically used to generate exports for destination systems thatrequire fixed-depth hierarchies (sometimes called a balanced tree.)

Figure 46 Exports—Int Layer Product Gen Report Dialog Box—Repeat Parameters Page

● Repeat Num Property defines a property that repeats a node within an export structure. Forexample, if node B within an A-B-C parent-child hierarchy has a Repeat Num Property witha value of 2, then the export looks like A,B,B,C (node B is repeated twice.)

● The Bottom Level Property and the Bottom Level Value determine the maximum depth of theexport structure. This value can defined as a hierarchy-level property (Bottom LevelProperty) or as an absolute value (Bottom Level Value.)

● If a bottom level is defined, the repeat options are enabled to automatically repeat nodesdown to the defined level in the export structure. For example, for nodes A-B-C in a parent-

Starting the Export Wizard 115

Page 116: DRM Manual

child hierarchy, if the Bottom Level Value is defined as 6, node B has a Repeat NumProperty value of 2, and the Repeat Bottom Node option is selected, then the export structureis A,B,B,C,C,C (the export structure is six levels deep, the leaf node C is repeated until level6 is reached, and node B is repeated twice).

● The Max Ancestor Levels is used to define the absolute maximum number of ancestor levelsin the export structure.

● If Use inverted level is selected, the Oracle Essbase level methodology is used where the leavesare at 0 and count up. For a node that has multiple branches under it, the node is the largestof the possible values.

● If Blank repeated levels is not selected, then a node may be repeated in the output to achievethe specified level. Checking this box will prevent the repeated nodes from appearing in theoutput.

● If Group repeated columns is selected repeated columns are grouped property in the ancestorcolumns.

Hierarchy Compare Export Parameters PageThe Hierarchy Compare Export Parameters page is used to select the appropriate options thatdefine how a Hierarchy Compare Export is generated. This page is very similar to the HierarchyDifference Report Parameters page.

Figure 47 Exports—Hierarchy Compare Export Dialog Box—Parameters Page

116 Running Exports

Page 117: DRM Manual

● The Type Codes define the text that is included in the export columns to identify the resultsof the compare for each type of result. These codes can be selected as output columns onthe Columns page of the export.

● If checked, Additions includes all nodes in the target (to) hierarchy that are not in the source(from) hierarchy.

● Conversely, if checked, Deletions includes all nodes in the source (from) hierarchy that arenot in the target (to) hierarchy.

● If checked, Merge includes merge information in the export (if the merge feature is enabled.)

● If checked, Moves includes all nodes that have different parent nodes in the two hierarchiesbeing compared.

● If checked, Renames includes all nodes that have different names (the Abbrev property) butthe same internal NodeID in the two hierarchies being compared.

● If checked, Property Updates includes all nodes that have different values in the specified listof properties in the two hierarchies being compared. Use the Add and Remove buttons toadd properties to the list of properties to be used. Clicking Edit opens the SelectProperties dialog box in which one or more properties may be selected.

Figure 48 Select Properties Dialog Box

Hierarchy Difference Report Parameters PageThe Hierarchy Difference Report Parameters page is used to select the appropriate options thatdefine how a Hierarchy Difference Report is generated.

Starting the Export Wizard 117

Page 118: DRM Manual

Figure 49 Export/Report—Test Diff Exp Dialog Box

● The functionality of the check boxes on this page is the same as on the Hierarchy CompareExport Parameters page described preceding.

● The Fixed Width Columns fields are used to define the column width of the Name and ParentNode name in the export. A fixed width cannot be set to zero.

Hierarchy Export Parameters PageThe Hierarchy Export Parameters page is used to select the appropriate options that define howa Hierarchy Export is generated.

118 Running Exports

Page 119: DRM Manual

Figure 50 Exports—Hierarchy Export Dialog Box—Parameters Page

● The Node Selection Options define whether all nodes are included in the export, or justthose that are limbs or leaves.

● Select Recurse from Top Nodes if the export should include a row for all nodes below thetop node selected. If not selected, then only the selected top node is included in the export(which is typically not the desired result.)

● Select Remove Duplicates Based on Keys if the primary key defined on the Column Optionspage should be used to suppress the export of duplicates.

● Select Include Implicitly Shared Nodes to include descendant nodes below shared limbnodes that have been explicitly shared. Implicit shared nodes are only exported if not filteredout by another option such as top node selection or a property query filter. The structureof implicitly shared nodes below a shared parent node is reflected in the ancestor section ofthe hierarchy export.

❍ If the Limb Nodes Only or Leaf Nodes Only option is used, the Shared Node is includedeven if it does not match the selected option (leaf or limb). This is done since theimplicitly shared node is substituted for the explicitly shared nodes and they areprocessed against the node selection options.

Starting the Export Wizard 119

Page 120: DRM Manual

❍ If a query filter is used in the export, the administrator must explicitly include the sharednodes for this option to work. For example, the filter (#Children=0) would need to bechanged to ((#Children=0 OR (Shared Node Flag = True)).

❍ For the implicitly shared node, the Parent properties will reflect the values of the actualnode, i.e. the primary node. For example, if your export includes the Parent Propertyfor an implicitly shared node, then it will show the parent as the primary node and notthe shared node.

● Select Tabbed Output to insert a tab character every level of the node (so that it resemblesa hierarchy when imported into other applications, such as Microsoft Excel.)

Note:

Tabbed output is not available if Include Implicitly Shared Nodes is selected.

Lookup Export Parameters PageThe Lookup Export Parameters page is used to select the appropriate options that define how aLookup Export is generated. This page is the same as the Property List Export Parameters page.

Figure 51 Exports—Lookup Export Dialog Box—Parameters Page

➤ To define the lookup export:

1 From the Property drop down box, select a property upon which to base this export.

2 Select any or all of the following options:

● Check the Column Headings check box to include column headings in the export.

● Check the Quoted Strings check box to enclose quotation marks around strings in the export.

120 Running Exports

Page 121: DRM Manual

● Check the Fixed Width check box to allow the explicit specification of field widths andseparators.

● Check the Differences Only to filter out lookup pairs where the source and target are thesame.

3 Select a field delimiter for the export from the Delimiter drop down box.

Property List Export Parameters PageThe Property List Export Parameters page is used to select the appropriate options that definehow a Property List Export is generated. It is the same as the Lookup Export Parameters page.

Merge Log Export Parameters PageThe Merge Log Export Parameters page is used to select the appropriate options that define howa Merge Log Export is generated.

Figure 52 Exports—Merge Log Export Dialog Box—Parameters Page

● Use Begin and End to select a date range for the merge log export. Clicking the down arrowat the right of these field opens a calendar that can assist in the selection of dates.

● The Filters fields allow filters for the export to be defined.

● Enter a Deleted Node to filter by a node name that has been deleted.

● Enter a Merge Node to filter by a merge node name.

● Use the Status to define if all nodes, or just deleted or inactivated nodes are to be includedin the export.

Starting the Export Wizard 121

Page 122: DRM Manual

● Enter a User to filter by a user name.

Transaction Log Export Parameters PageThe Transaction Log Export Parameters page is used to select the appropriate options that definehow a Transaction Log Export is generated.

Figure 53 Exports—Trans Log Export Dialog Box—Parameters Page

● Use From and To options to select a date range for the export. Clicking the down arrow atthe right of these fields opens a calendar that can assist in the selection of dates.

● The From ID and To ID options allowing specification of a specified range of IDs.

● The Action fields can be used to filter the export to include just the specified action typesfrom the transaction log.

● The Filters are used to filter the export. Most filters are a comma-delimited list of names(e.g. node names) that can be built by clicking the ellipses [...] buttons.

● The Node field is used to define a list of nodes that acts as a filter for the export.

● The User field is used to define a list of users that acts as a filter for the export.

122 Running Exports

Page 123: DRM Manual

● The Property field is used to define a list of properties that acts as a filter for the export.

● Other options allow the export to Include Child Nodes, Filter to Current Session, and RunExport for All Versions.

Version Export Parameters PageThe Version Export Parameters page is used to select the appropriate options that define how aVersion Export is generated.

● The Node Selection Options define whether all nodes are included in the export, or just thosethat are limbs or leaves.

Figure 54 Exports—Version Export Dialog Box—Parameters Page

Ancestor Export Parameters PageThe Ancestor Export Parameters page is used to configure the following parameters:

● Node Direction: determines how the ancestor list is ordered

● Reporting Style: enables listing ancestors by Name or by Description

● Include Description: option to include the Description of the bottom node

Starting the Export Wizard 123

Page 124: DRM Manual

Figure 55 Exports—Ancestor Export Dialog Box—Parameters Page

Verification and Filter PageThis page is used to select a verification and define a filter for the export. Any available verificationcan be selected from the drop-down list to be applied to the export.

To define a filter, click the Edit button to open the Property Query Editor. From the editor, anew query can be created or an existing one can be selected from the list.

The defined filter query is then displayed in the Property Filter section. Clicking the Clear button,removes the filter query.

For most export types, the filter is used to restrict the export output to only those nodes thatmeet the filter criteria. However, for Hierarchy Compare Exports, it is important to note thatthe filter determines the set of nodes from each hierarchy that will be compared. For example,when checking for node additions or deletions and a filter is not used, a node that exists in bothhierarchies does not show up in the export result. However, if a filter is used and the node meetsthe filter criteria in one hierarchy but not in the other, that node appears as a difference (eitheran addition or deletion.)

124 Running Exports

Page 125: DRM Manual

Figure 56 Export/Report—Hierarchy Export Dialog Box—Verification and Filter Page

Exclusion Filter PageThis page is used by some export types to define a filter that excludes nodes from the export.The process for creating and editing the filter criteria is similar to that used on the Verification/Filter page.

The exclusion filter is used in two different ways:

● For the Generation Hierarchy Export, the filter is used to restrict the nodes that appear asAncestor Columns.

● For the Hierarchy Compare Export, the filter is used to exclude nodes that exist in thecomparison result from the export output.

Figure 57 Exports—Int Layer Product Gen Export Dialog Box—Exclusion Filter Page

Starting the Export Wizard 125

Page 126: DRM Manual

Output Formatting PageThis page is used by most export types to specify formatting options for the export results.

Figure 58 Exports—Hierarchy Export Dialog Box—Output Formatting Page

126 Running Exports

Page 127: DRM Manual

In the Format section, select one or more of the following options:

● Column Headings - to include column headings in the export.

● Quoted Strings - to enclose quotation marks around strings in the export.

● Fixed Width - to allow the explicit specification of field widths and separators. If this optionis selected, the next dialog box presented is the Column Widths page.

In the Delimiter section:

● From the Field drop-down list, select a field delimiter character.

● From the Record drop-down list, select a record delimiter character.

In the Header/Footer section:

The header and footer options are used to specify text to be printed on the header and footer ofthe export results. Multiple lines of text can be entered either directly into the text box or click

to open the pop-up text editor.

Customization tags can also be inserted to further enhance the readability of the export results.The tags use the format <%Tagname(parameters)%> and are replaced with the appropriatevalue at run time. In the list following, optional parameters are enclosed in [brackets].

The following table describes the customization tags that are available for use.

Table 28 Customization Tags

Customization Tag Description

<%Date[(format)]%> Returns current date where format = MM/DD/YYYY

<%Time[(format)]%> Returns current time where format = HH:MM:SS AMPM

<%Timestamp%> Returns combination of date and time.

<%CurrentUser%> Returns current Data Relationship Management user.

<%CurrentVersion%> Returns current Data Relationship Management versionfor this export.

<%PreviousVersion%> Returns previous Data Relationship Management versionfor this export.

<%ExportName%> Returns name of export.

<%FileName%> ● Returns output file name if specified

● Returns default file name if not specified

<%RecordCount%> Returns count of records exported (only available infooter)

<%AppVersion%> Returns the Data Relationship Management productnumber (for example, 4.6.0.1)

<%PropValue()%> Returned value depends on the specified export type asdescribed following:

Starting the Export Wizard 127

Page 128: DRM Manual

Customization Tag Description

<%PropValue([Previous|Current(Default)], PropName)%>

For Compare/Difference Exports, returns value of firstnode in CompareCriteria for Previous/Current version

<%PropValue([HierName], PropName)%> ● For Hierarchy Exports, returns value from first node inlist

● If HierName is supplied, return value from the firstnode that matches HierName

<%PropValue(PropName)%> For Version Exports, returns only version properties

The Blank line between Header/Footer and Body check box may be used to improve the readabilityof headers and footers by adding white space.

In the Replace section, select up to three characters from the lists on the right to be replaced bythe characters selected from the lists on the left. All instances in the export output are replacedas specified. For example, all parentheses can be replaced by braces.

Output Destination PageThis is the final page in the dialog box sequence for all export types and determines thedestination of the export output. Select one of the options and click Run to generate the exportresults:

● File — results are written to a file. Enter file path or click to browse.

Note:

If only a file name is specified, the default directory specified in the Tools-Options menu isused to locate the file.

● Preview — results are displayed in a pop-up window.

● Table — results are exported to a database table.

Export to Table OptionFor certain export types, the output can be sent to an external database table. This featurecurrently supports both MS SQL and Oracle databases.

Select the Table option and click the [...] button to open the Export to Table configuration dialogbox.

128 Running Exports

Page 129: DRM Manual

Figure 59 Export to Table Options

➤ On the Output Properties tab, configure the following items.

1 From the DAL list, select ADO

2 Define a Connection String for accessing the external database. Either enter an existing connection stringor click the [...] button to build one using the Data Link Properties dialog box. If the connection string isalready known, enter it directly and then skip to step 8.

Starting the Export Wizard 129

Page 130: DRM Manual

Figure 60 Data Link Properties - Provider Tab

3 On the Provider tab, select the appropriate ODBC driver for the type of external database being used. Thenclick the Next button.

130 Running Exports

Page 131: DRM Manual

Figure 61 Data Link Properties - Connection Tab

4 On the Connection tab, specify the server name where the external database resides.

5 Select the desired type of security for accessing the database and enter the appropriate information. Notethat the connection string information, including passwords, is encrypted when saved to the Data RelationshipManagement database.

6 Select the name of the external database. The Test Connection button can be used to verify a connectionusing the specified information.

7 Click OK to close the Data Link Properties dialog box.

Starting the Export Wizard 131

Page 132: DRM Manual

Figure 62 Export to Table - Output Properties Tab

8 In the Table field, specify the desired table name in the external database. Note that the table must alreadyexist before the export can be run.

9 If the User ID and Password are not specified within the connection string, they can be entered in theappropriate fields.

10 Selecting the Use Transactions option causes the export to be performed within a database transaction andallows the entire operation to be rolled back if an error occurs during the export.

11 The Use Fast Appends option applies only when using a database-specific DAL. This option can be ignoredwhen using the ADO DAL.

12 In the Clear Table section, select the desired option:

● Do not clear table causes the export to append to any data that already exists in the specifiedtable.

● Delete based on Version ID(s) deletes any existing data in the table where the specified keyfield is equal to the current version ID of the data being exported. See additional detailsbelow on selecting a Key field.

● Delete all rows deletes all existing data from the table before writing the export output.

13 On the Column Properties tab, each column being exported must be mapped to a field in the externaldatabase table. Under Field Name, enter the appropriate name of an existing field.

132 Running Exports

Page 133: DRM Manual

Figure 63 Export to Table - Column Properties Tab

14 Select the Field Type of the database field.

15 For fields of type String, specify the Length. For all other field types, the Length is not used.

16 If the Delete based on Version ID(s) option is being used, a Key field must be specified. When the export isrun, all data in the table is first deleted where the Key field is equal to the current version ID of the databeing exported. If one of the other options is being used (i.e. Do not clear table or Delete all rows) then theKey field designation is ignored.

17 Once all desired settings have been configured, click OK to close the Export to Table dialog box.

The export is now ready to run.

Note that exports configured to output to a table can be run within an export book along withother exports configured for file output.

Using Export BooksSaved exports can be grouped and run together in Export Books. This enables a set of commonlyused exports to be executed with one action rather than individually.

Note:

Book exports cannot reference multiple versions. All exports for the book must reference thesame version.

Using Export Books 133

Page 134: DRM Manual

➤ To create an export book:

1 Select the Book icon in the Export dialog box.

2 Right-click and select New Book.

Figure 64 Manage Export Books Dialog Box—Content Tab

3 On the Content tab, enter a name and description for the book.

4 Optional: Select Standard Book to make the book available to all users.

5 From the Available list, select the exports that you want to include in the book and use the arrow buttonsto move them to the Selected list.

6 On the Output tab, specify the desired file names if the output is to be combined.

134 Running Exports

Page 135: DRM Manual

Note:

If only a file name is specified, the default directory specified in the Tools-Options menu is usedto locate the file.

The Pre File and Post File can be used to specify data that is prepended and appended,respectively, to the combined output file.

Note:

When a book contains both exports configured to output to a file and some configured to outputto a database table, the Combine option only affects the exports that are writing to files.

Figure 65 Manage Export Books Dialog Box—Output Tab

Using Export Books 135

Page 136: DRM Manual

136 Running Exports

Page 137: DRM Manual

8Using Verifications and

Validations

In This Chapter

Validations... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 137

Verifications ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 137

Validation or Verification ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 137

Running Validations ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 138

Running Verifications ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 138

Validations● Run automatically (in real-time) as users are editing the structure and properties of

hierarchies.

● Are automatically performed for the node being edited and also for its parent.

● Have the primary function of denying an attempted update that is invalid. If any validationfails during an update, the update is denied.

Verifications● Run on-demand (batch) after users have made a set of changes.

● Can be run individually or run in sets defined by the system administrator.

● Can be inheriting or non-inheriting. If they are inheriting, they run for the node selected orassigned and all descendant nodes. Non-inheriting verifications run on the selected nodeonly.

● Can be applied to a node and its descendants, a hierarchy, or an entire version. When appliedat the version level, the verification is run for all nodes in every hierarchy.

● Are similar to queries in that they return a set of nodes that fail the business rule.

Validation or VerificationAssume that an organization has a business rule that requires that a sales representative who hasbeen assigned more than twenty customers must obtain special approval from the marketingdepartment.

Validations 137

Page 138: DRM Manual

● A Validation that supports this business rule within Data Relationship Management doesnot allow more than 20 customers to be added to a sales representative node.

● A Verification supporting the same business rule reports upon all of those salesrepresentatives assigned more than 20 customers.

In summary, some business rules call for real-time enforcement, and such rules should be definedby the system administrator as Validations. Other business rules just need to be monitored, andshould be established as Verifications.

Validation CharacteristicsIn order for a rule to be a candidate for a Validation, it must have the following characteristics:

● There are absolutely no exceptions to the rule.

● There no conceivable timing issues where the rule may temporarily be broken before it canbe enforced.

Note that many business rules have exceptions. And for those that do not have exceptions, manystill need to be suspended temporarily in order to complete an update. For example, a commonrule that Data Relationship Management enforces is called StrandedParent. This rule ensuresthat all nodes defined as limbs do, in fact, have children. However, the StrandedParent rule mustbe enforced as a Verification, because all new limbs start out with no children. If this rule wereset up as a Validation then no new limb can be added.

Validation and Verification AssignmentBoth validations and verifications can be assigned by the system administrator to versions,hierarchies, or specific node chains.

● By assigning Validations, the system administrator is establishing a set of “hard” rules thatcannot be broken and which are enforced real-time during hierarchy maintenance.

● Assigned Verifications are a list of rules that users can run on-demand in order to verify theaccuracy of a hierarchy.

Running ValidationsValidations are run automatically whenever any changes to a node are saved. If a node fails avalidation, the action is cancelled and an error message is displayed.

Running VerificationsVerifications run in a batch mode on request.

138 Using Verifications and Validations

Page 139: DRM Manual

➤ To run a verification, perform the following:

1 Right-click a node and select Verify.

2 Select one of the following options:

● Assigned: Runs a list of Verifications (pre-assigned by the system administrator) on theselected node.

● Selected: Displays the Select Verifications dialog box.

3 If you selected Selected in step 2, each available Verification is listed and can be selected to run by checkingthe box.

Click Assigned to select only the verifications assigned by the system administrator.

Figure 66 Select Verifications Dialog Box—Verification Tab

4 Click the Options tab and select to one of the following options to configure the node list returned by theverifications.

● Show in list - all nodes that failed a Verification are displayed in a Hot List

● Mark Nodes - all nodes that failed a Verification are marked in the Hierarchy

● Both - nodes are marked and a Hot List is displayed

5 Click OK to run the selected verifications.

Figure 67 Select Verifications Dialog Box—Options Tab

Running Verifications 139

Page 140: DRM Manual

Viewing Verification Results

➤ To view the results of the verifications:

1 Select the appropriate version in the Version control window.

2 Right-click and select Verification Messages to display the results window.

140 Using Verifications and Validations

Page 141: DRM Manual

9Running Property Queries

In This Chapter

Working with Property Queries .. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 141

Property Query Types ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 142

Performing Queries.. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 142

Property Query Options ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 146

Hot Lists.. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 148

A property query enables the investigation of the hierarchical structure and the property valuesof sets of nodes without the need for complex recursive programming. Historically, queryinghierarchically structured data through a database using Structured Query Language (SQL) hasalways been difficult, if not impossible, due to the recursive nature of the required query.

Property queries can be used as the basis for filters for exports and compares and as the basis forvalidations and verifications.

Working with Property QueriesWithin Data Relationship Management, the Property Query supports a number of operatorssuch as LIKE, IN, LENGTH, etc. A list of criteria can be created (similar to the WHERE clausein a conventional SQL statement) that can be run against a set of nodes. The Property Queryreturns a list of nodes that meet the defined criteria. Property Queries can comprise multiplecriteria that can be grouped together using AND or OR to form complex queries.

Property queries may be saved so different users can develop a tool kit of queries. The systemadministrator can create “standard” queries that are available for use by all other users.

Typical uses of a Property Query might be:

● To locate nodes that meet certain criteria.

● As a filtering mechanism in exports and comparisons.

● As a parameter in one of the generic validation routines (this enables queries to haveadditional functionality as validations.)

Working with Property Queries 141

Page 142: DRM Manual

Property Query TypesProperty queries have two distinct flavors:

● Normal Property Queries are defined and performed against a node and its children withina hierarchy. They can be run from the top node of a hierarchy or from a node within thehierarchy. The query can reference all properties.

● Global Property Queries are performed against all nodes in a version. Because the globalquery runs against a set of nodes without reference to any specific hierarchy, only globalproperties may be included in the criteria.

Performing QueriesThe drop down list at the top of the Property Query dialog box contains all previously savedqueries.

➤ To create and perform a new query:

1 From the Tools menu, select one of the following options:

● Property Query

● Global Property Query

142 Running Property Queries

Page 143: DRM Manual

Figure 68 Property Query Dialog Box

2 Select a version.

3 If not a Global Property Query, then select a hierarchy and top node for the list of nodes to be queried bydoing the following:

a. Click the button to the right of the Hierarchy field to display the Select Node dialog box:

b. Select a hierarchy from the top drop-down box.

c. Navigate the hierarchy to select a top node.

d. Click OK.

Performing Queries 143

Page 144: DRM Manual

Figure 69 Select Node Dialog Box

4 Click Add to build the query criteria.

Query criteria are the building blocks of the query system. Each consists of a property, acomparison operator, and a comparison value. Within the Property Query Item dialog box,select the Property to use, the Query Comparison Operator, and enter a Value to compareagainst. Add multiple criteria as needed.

Figure 70 Property Query Item Dialog Box

Note that:

● Only those query comparison operators relevant to the data type of the selected property isavailable.

● The list of properties can be displayed in full or filtered by the property category.

● By checking the Include Inherited option, the query runs against values that are bothoverridden and inherited (this is the default behavior.) If this option is not checked, thenonly overridden values are used in the search.

● The Defined checkbox is a special criteria that marks a node that has a value saved at thatnode (i.e. overridden.) It does not do any comparison of the actual value of these nodes.

● For string properties, the Use String Length checkbox is available to allow comparisons tobe done against the property string length instead of the absolute value of the string itself.

144 Running Property Queries

Page 145: DRM Manual

● The Compare Value is typed into the entry box. This box is unavailable if a value is notrequired.

The query comparison operators that are available for use are described in the followingtable.

Table 29 Query Comparison Operators

Comparison Operator Description

Equal The value of the property is equal to the compare value

Not Equal The value of the property is not equal to the compare value

Greater Than The value of the property is greater than (but not equal to) the compare value

Greater Than, Equal The value of the property is greater than or equal to the compare value

Less Than The value of the property is less than (but not equal to) the compare value

Less Than, Equal The value of the property is less than or equal to the compare value

In Strings only—The value of the property is in the string in the compare value

Not In Strings only—The value of the property is not in the string in the compare value

Contains Strings only—The value of the list property contains the element in the compare value

Does Not Contain Strings only—The value of the list property does not contain the element in the comparevalue

Like Strings only—The value of the property is like (similar to SQL "LIKE" comparisonoperator) the string in the compare value

Not Like Strings only—The value of the property is not like (similar to SQL "LIKE" comparisonoperator) the string in the compare value

Above Returns all nodes in the hierarchy that are preceding (i.e. that are antecedents of) thenode for which the value of the property is equal to the compare value

This is typically used to identify nodes in a hierarchy that are preceding a designated'end point' (such as a reporting base node, which may be flagged by a Boolean property)

Not Above Returns all nodes in the hierarchy that are not preceding (i.e. that are not antecedentsof) the node for which the value of the property is equal to the compare value

This is typically used to identify nodes in a hierarchy that are not preceding a designated'end point' (such as a reporting base node, which may be flagged by a Boolean property)

Below Returns all nodes in the hierarchy that are below (i.e. that are descendants of) the nodefor which the value of the property is equal to the compare value

This is typically used to identify nodes in a hierarchy that are following a designated'end point' (such as a reporting base node, which may be flagged by a Boolean property)

Not Below Returns all nodes in the hierarchy that are not following (i.e. that are not antecedentsof) the node for which the value of the property is equal to the compare value

This is typically used to identify nodes in a hierarchy that are not following a designated'end point' (such as a reporting base node, which may be flagged by a Boolean property)

Performing Queries 145

Page 146: DRM Manual

Comparison Operator Description

Is Blank The value of the property is blank (the compare value field is unavailable)

Is Numeric The value of the property is a numeric value (the compare value field is unavailable)

Is Not Numeric The value of the property is not a numeric value (the compare value field is unavailable)

Is Not Blank The value of the property is not blank.

5 Go to the Options tab and set the output options.

Figure 71 Property Query Dialog Box

6 Use the speed buttons on the top of the dialog box to save the query.

7 Click OK to perform the query. A Hot List of nodes that match the query criteria are generated and displayed.

Property Query OptionsThe Options tab of the Property Query dialog box includes the options described in the followingtable.

Table 30 Property Query Options

Option Description

Include Match and Parents Returns all nodes that meet the criteria, plus their ancestors.

146 Running Property Queries

Page 147: DRM Manual

Option Description

Include Match and Children Returns all nodes that meet the criteria, plus their descendants.

Include Match Only Returns only nodes that match the criteria (the default behavior.)

Expand List Available for Include Match and Parents and Include Match and Children. Whenselected, it allows nodes to be included that are outside of the original scope of thequery.

For example, in the following hierarchy, if the query starts with Node C and Match andParents and Inclusive are selected, the result is D and C. If expand list is selected, theresult is D, C, B, and A.

A

B

C

D * Node matching the criteria

E

Expand List only includes additional ancestors if the top node specified for the querydid not include all ancestors (Include Match and Parents option). Thus, this option hasno effect on descendants (include Match and Children option).

Note: This option is not applicable for Global Property Query.

Inclusive Available for Include Match and Parents and Include Match and Children. Whenselected, it includes the node matching the criteria in the result. This is selected anddisabled for Include Match Only.

Show in list Returns a HotList of nodes that meet the criteria.

Mark nodes Marks nodes that meet the criteria in the hierarchy.

Note: This option is not applicable for Global Property Query.

Both Returns a HotList of nodes and marks them in the hierarchy.

Display Query Criteria Causes extra columns to display in the result set based on the properties being queried.

For example, if property query criteria is # Limb Children > 0 and the Display QueryCriteria option is selected, then the result set includes a column for # Limb Childrenthat displays the value for each node. If Display Query Criteria is not selected, then thiscolumn is not added and only the default columns and properties are displayed in theresult list.

Expand to Marked Nodes This option is available with Mark Nodes and Both. When selected, the hierarchy opens(if it is closed) and expands to the matching nodes and they are marked.

Note: This option is not applicable for Global Property Query.

Given the following hierarchy:

A B C D *Node matching the criteria E The Inclusive option turns on or off the inclusion of thematching node. The Expand list allows for nodes outside of the original scope of the query tobe included So if we started our query at Node C and did a Match and Parents Inclusive wewould get (D and C) if we added the expand list we would get D, C, B, and A) Note: Expand Listonly serves to include additional ancestors if the top node specified for the query did not include

Property Query Options 147

Page 148: DRM Manual

all ancestors. (i.e Include Match and Parents option) Thus, the Expand List option has no effecton descendants (i.e in Include Match and Children option)

Hot ListsA hot list is a list of nodes returned as a result set from operations such as property queries,compares, and verifications. The hot list enables the user to jump from any node in the list tothat node in its hierarchy.

● If the list contains nodes from more than one hierarchy, the hot list dialog box displays atab for each hierarchy.

● Hot lists can be saved to a file or printed.

The Hide node feature enables nodes to be hidden or shown in the list for purposes of saving,printing, and reconciling.

Figure 72 Property Query—Hot List Dialog Box

The options on the hot list toolbar are listed in the following table.

Table 31 Hot List Toolbar Buttons

Toolbar Button Description

Refresh list Run the specified operation again and refreshes the result list

View Parameters For query results, open the Property Query dialog box to view the specified query

Show/Hide Hidden Nodes Toggle the display of nodes that are set to be hidden

Print Send the result list to a printer

Save to File Save the result list to a file

Find a Node Open the Find Node dialog box to search for a node

148 Running Property Queries

Page 149: DRM Manual

Toolbar Button Description

Find Next Search for the next node meeting the current Find criteria

Right-clicking on a node in the Hot List displays the options in the following table.

Table 32 Hot List Right-click Options

Option Description

Hide Set the node to be hidden in the list.

Show Set the node not to be hidden in the list.

Go To Jump to the node in its hierarchy.

Print Send the result list To Printer or To File.

View Ancestors Display another list with the ancestors of this node.

View Siblings Display another list with the siblings of this node.

View Descendants Display another list with the descendants of this node.

View Children Display another list with the children of this node.

View Links Display another list with all occurrences of this node in all hierarchies.

Transaction History Open the Transaction History dialog box filtered for just this node.

Hot Lists 149

Page 150: DRM Manual

150 Running Property Queries

Page 151: DRM Manual

10Comparing Hierarchies

In This Chapter

Hierarchy Compare Types ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 151

Comparing Hierarchies ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 152

Hierarchy Compare TypesThree hierarchy compare types are available:

● “Standard Compare” on page 151

● “Property Compare” on page 151

● “Renamed Node Compare” on page 152

Standard CompareThe standard compare requires that two points in different hierarchies be selected. Theirstructures are then analyzed for differences. The points may be in different versions. This is oneof the very few features of Data Relationship Management that transcends the boundaries ofversions.

A standard compare returns two lists:

● a list of all the nodes that exist in the first hierarchy but not the second

● a list of all nodes that exist in the second hierarchy but not in the first

Property CompareThe property compare enables two points in different hierarchies to be selected, and then aparticular property is analyzed for any differences.

A property compare returns two lists:

● a list of all the nodes where the properties are different showing the values of the propertiesin the first hierarchy

● a list of all the nodes where the properties are different showing the values of the propertiesin the second hierarchy

Hierarchy Compare Types 151

Page 152: DRM Manual

Renamed Node CompareThe renamed node compare is the same as the standard compare, but it treats renamed nodesas being the same for comparison purposes.

For example, if Hierarchy 1 in a compare includes nodes A, B and C, and hierarchy 2 containsthe same nodes but with node C renamed to CC, then the renamed node compare does notidentify any differences between the two hierarchies. A standard compare regards nodes C andCC as different if the differences option is selected.

A renamed node compare returns two lists:

● List of all the nodes that exist in the first hierarchy but not the second

● List of all nodes that exist in the second hierarchy but not in the first

Property queries may be used to filter the lists of nodes to be compared.

Comparing Hierarchies

➤ To perform an existing or create a compare, perform the following:

1 Select one of the following options from the Tools menu:

● Compare

● Property compare

● Renamed node compare

152 Comparing Hierarchies

Page 153: DRM Manual

Figure 73 Compare Hierarchies Dialog Box

2 To use an existing definition of a Compare, make a selection from the Compare Name drop down box. Youmay then amend any of the saved definitions.

3 To create a new Compare, on the Top Nodes tab select the top node for each of the two hierarchies to be

compared (Hierarchy 1 and Hierarchy 2), by selecting a version and by then clicking and selecting anode from the hierarchical list of nodes in the Select Node window.

4 If a Property Compare was selected in step 1, then the Properties tab is available.

Comparing Hierarchies 153

Page 154: DRM Manual

Figure 74 Property Compare Dialog Box

5 From the list of available properties, select the properties to be compared by clicking the arrow buttons inthe center of the dialog box to move the required properties to the Selected Properties list.

6 On the Options tab select the Comparison Type, Filtering Options, Display Options and Property Filter (if any)for the comparison.

154 Comparing Hierarchies

Page 155: DRM Manual

Figure 75 Compare Hierarchies Dialog Box

7 Select alternate join property if desired.

By default, the compare operation maps nodes from each hierarchy that have the same name.It is also possible to join nodes based on other properties.

For example, if a property named SortCode was a unique key in the specified hierarchies, thenthis property can be used in the Compare to identify differences/similarities between nodeshaving the same SortCode in each hierarchy.

8 If a Renamed Node Compare has been requested, the Comparison Type options are not available.

If a standard Compare is being performed, then the Treat renamed nodes as similar option isonly available if the Comparison Type is Similarities.

9 When all desired options are defined, click OK to perform the comparison.

10 When running a new Compare, the Save As prompt will appear.

To save the new Compare configuration, enter the Name and Description. The Save as Standardoption can be checked to make the new Compare available to other users.

The results of the compare are displayed in a list and the relevant hierarchy windows are opened.

Comparing Hierarchies 155

Page 156: DRM Manual

156 Comparing Hierarchies

Page 157: DRM Manual

11Viewing Transaction History

In This Chapter

Administrative Actions in Transaction History .. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 157

Data Actions in Transaction History .. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 159

Transaction History Range and Filter Specification ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 161

Transaction History Details .. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 163

Administrative Actions in Transaction HistoryAll Data Relationship Management operations are logged in the Transaction History. This datacan be viewed by selecting Tools, then Transaction History from the Data RelationshipManagement main menu. Each operation is recorded with a time stamp, the user name, the typeof action performed, and other relevant information.

The Transaction History records all changes to metadata such as property definitions, systempreferences, and export profiles. The following administrative actions are logged in thetransaction history:

Node Access Groups

● Add Node Access Group

● Update Node Access Group

● Update Access Group Members

● Update Access Group Controlling Hiers

● Delete Node Access Group

● Node Types

● Add Node Type

● Update Node Type

● Apply Node Type Props

● Apply Node Type Validations

● Delete Node Type

Properties

● Add Property Definition

Administrative Actions in Transaction History 157

Page 158: DRM Manual

● Update Category List for Prop Def

● Update Property Definition

● Update Property Definition Parameters

● Update Controlling Hierarchy

● Update Property List Values

● Add Property Lookup Value

● Delete Property Lookup Value

● Delete Property Definition

Property Categories

● Add Category

● Update Category

● Update Category Users

● Update Category Properties

● Delete Category

System Preferences

● Update System Preference

System Categories

● Add System Category

● Update System Category

● Delete System Category

User Management

● Add User

● Set User Password

● Update User

● Assign User Node Access Groups

● Assign User Categories

● Delete User

● Update User Lockout

Validations

● Add Validation

● Set Validation Params

● Update Validation

158 Viewing Transaction History

Page 159: DRM Manual

● Delete Validation

Import

● Save Import

● Delete Import

Export

● Save Export

● Delete Export

Book

● Save Book

● Delete Book

Blender

● Save Blender

● Delete Blender

Property Query

● Update Criteria List

● Delete Criteria List

Compare

● Save Compare Criteria

● Update Compare Criteria

● Delete Compare Criteria

Data Actions in Transaction HistoryThe transaction history provides a record of all the data changes to the system such as version,hierarchy, and node data, as well as logging many basic functions such as user logins, verificationsrun, and so on. The data transactions are categorized by action types. Following is a list of theaction types that are logged:

Version Hierarchy and Node Data Changes

● Add Hierarchy

● Add Node

● Add Orphan Node

● Add Version

Data Actions in Transaction History 159

Page 160: DRM Manual

● Annul Node

● Annul All Below Node

● Assign Hierarchy Validations

● Assign Version Validations

● Change Top Node

● Clear All Below

● Copy Version

● Delete Hierarchy

● Delete Node

● Delete Orphan

● Delete Version

● Detach Version

● Disable Real-Time Validations

● Inactivate Node

● Insert Node

● Lock Node Property

● Move Node

● Lost Property Value From Node

● Order Children

● Reactivate Node

● Remove Duplicate Property Values

● Remove From Orphan

● Remove Hierarchy Property Value

● Remove Node

● Remove Node Property Value

● Remove Version Property Value

● Save Version

● Unlock Node Property

● Update Hierarchy Property Value

● Update Node Property Value

● Update Version Property Value

Logging Actions

● Assigned Batch Verifications Run

● Selected Batch Verifications Run

160 Viewing Transaction History

Page 161: DRM Manual

● BCP Run

● Automator Run

● Blender Run

● Close Version

● Compare Run

● Export Run

● Global Query

● Import Run

● Log In

● Log Out

● Open Version

● Property Compare Run

● Query

● Rebuild Hierarchy Node Table

● Rename Compare Run

Transaction History Range and Filter SpecificationThe data displayed can be restricted to a desired range by specifying either:

● From Date/Time and To Date/Time

● From and To transaction ID

After setting the desired range, click the Refresh button to display data within the range.

Transaction History Range and Filter Specification 161

Page 162: DRM Manual

Figure 76 Transaction History

The data can also be filtered on other columns including:

● Version

● Hierarchy

● Node

● Action

● Level

● User

● Property

162 Viewing Transaction History

Page 163: DRM Manual

Figure 77 Transaction History

By checking the Filter to Current Session box, the display is limited to only those operationsperformed because the current user logged in to Data Relationship Management.

The Max Records value can be set to limit the number of transactions displayed.

Clicking the Automate button opens the Automator Window and enables the user to save thetransactions as an Automator file or process them through the Automator.

Transaction History DetailsTo view the details of a specified transaction, select the record in the grid then right-click andselect the Properties option. This opens the Transaction History Detail dialog box.

Transaction History Details 163

Page 164: DRM Manual

Figure 78 Transaction History Details

Figure 79 Administrative Action Detail

164 Viewing Transaction History

Page 165: DRM Manual

12Using the Data Relationship

Management Batch Client

In This Chapter

Overview ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 165

Securing the Batch Client .. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 166

Running the Batch Client.. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 166

Command Line Syntax.. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 167

Configuration File Syntax .. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 172

Outputs and Result Codes ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 178

OverviewThe Data Relationship Management Batch Client is a command-line utility(mdm_connect_ntier.exe) that allows access to various Data Relationship Managementoperations in batch mode including:

● Automator

● Import

● Blender

● Export (individual export and book export)

● Opening and closing versions

By passing command-line parameters appropriate to the operation, the Batch Client is able tolog into the Data Relationship Management engine using supplied credentials, submit a requestto perform the given operation, and receive any corresponding results from the server, whilelogging its activities as it works. If the operation is successful, an error level value of 0 is returned.If the operation fails, a non-zero error level value is returned. For information on error levelvalues, see Table 52 on page 178.

The Batch Client accepts options from the command line, a configuration file, or a combinationof the two.

Note:

If an option is supplied in both a configuration file and the command line with different values,the value on the command line takes precedence over the value in the configuration file.

Overview 165

Page 166: DRM Manual

Securing the Batch ClientThe Batch Client (mdm_connect_ntier.exe) is used to perform batch processes in DataRelationship Management. It requires a username and password to be able to connect to theData Relationship Management server.

The Batch Client can use the Windows Data Protection Application Interface (DPAPI) to allowa more secure method to storing credentials for the Batch Client. The DPAPI protects theinformation and places it in a location that is only accessible to the user that creates it. DataRelationship Management provides a command line utility(mdm_connect_credentials.exe) that can set the credentials for use by the Batch Client.

When the Batch Client runs and no credentials are passed on the command line or in theconfiguration file, then it uses the credentials stored using the Windows DPAPI.

Setting up Batch Client CredentialsThe Credential Utility (mdm_connect_credentials.exe) is used to setup the username andpassword credentials for the Batch. mdm_connect_credentials.exe associates a DataRelationship Management user to the current Windows account in order to execute the BatchConnect tool securely.

The following command line parameters are valid:

● Add — Stores Data Relationship Management credentials for the current Windows account.

● Clear — Clears the Data Relationship Management credentials for the current Windowsaccount from the secure store.

● Info — Displays the Data Relationship Management username associated with the currentWindows account.

● ? — Displays the help file.

If no arguments are passed, the credential utility launches an interactive prompt.

Running the Batch Client

➤ To run the Data Relationship Management Batch Client:

1 Open a command prompt.

2 Navigate to the directory where you downloaded the installation program and to Hyperion\MasterData Management.

3 Enter mdm_connect_ntier, followed by the parameters as described in this chapter.

The Batch Client can be run from a command prompt or it can be scheduled to run. The BatchClient executes in the following order:

1. Opens the log file. If the log file already exists, the Batch Client appends to it. If the log filedoes not exist, the Batch Client creates it.

166 Using the Data Relationship Management Batch Client

Page 167: DRM Manual

2. Processes and validates options from the command line or configuration file.

3. Logs into Data Relationship Management using supplied credentials.

4. Runs the appropriate operation.

5. Writes any output file.

6. Logs out of the server, closes the log file, sets the error level and exits.

DependenciesThe Batch Client must run on a computer that meets the requirements for Data RelationshipManagement client software.

The Batch Client requires an HTTP connection to Data Relationship Management. The userlogin under which it runs must have permissions to use the connection and to read files fromdirectories indicated for input files and to write to directories indicated for log files and exportfiles. For more information on Data Relationship Management N-tier requirements, refer to theOracle Hyperion Data Relationship Management N-tier Installation Guide.

Note:

The Batch Client is a stand-alone utility program and is not accessible from within the DataRelationship Management client interface.

Saving Versions in the Batch Client

Note:

When using the Batch Client, As Of versions can be specified only as date and time. As Of versionsthat use date offsets and transaction IDs are not valid.

When the Batch Client runs, it logs into an existing Data Relationship Management applicationserver. When new versions are created, they remain detached (not saved to the database) on theapplication server until they are explicitly saved.

When running an Import or Blend via the Batch Client, there is an option to save the versionthat is created (Autosave=True). The version can be saved or left as detached.

Command Line SyntaxThe Batch Client can be used with the command-line parameters described below. Bracketedvalues ( [ ] ) are optional extensions provided for clarity. Both shorter and longer versions ofthe value are supported. Commands and parameters are not case sensitive.

Command Line Syntax 167

Page 168: DRM Manual

Caution!

For all parameters, version names containing a space must be enclosed in quotes, for example,“APR 2007”.

Table 33 describes the command-line parameters for all operations.

Table 33 All Operations

Parameter Description

/op= Specifies the operation to perform. Specify one of the following values:

● A[utomate]

● B[lend]

● C[lose]

● E[xport]

● I[mport]

● O[pen]

● R[efresh]

● D[elete]

This parameter is required

/u= Specifies the Data Relationship Management user name for login.

/pw= Specifies the Data Relationship Management password for login.

/url= Specifies the URL (including http:// or https://) for the Web server hosting Data RelationshipManagement. For example, "http://www.myserver.com/mdm_ntier"

Note that this is the same URL used when defining login connections for the N-tier client. Enclosingthe value in double quotes is recommended.

This parameter is required.

/log= Specifies the path and file name for the log file. If the file exists, the log is appended to the endof the existing file. Enclosing the value in double quotes is recommended.

This parameter is optional. If not specified, the following name is used:MDMConnectMMDDYYYY.log, where MM = month, DD = day, YYYY = year

/cfgfile= Specifies the path and file name of the configuration file describing desired options. Enclosingthe value in double quotes is recommended.

/h[elp] | /? Displays a list of command-line parameters.

The following tables describe the command-line parameters that can be used with eachoperation.

168 Using the Data Relationship Management Batch Client

Page 169: DRM Manual

Table 34 Automate Parameters

Parameter Description

/infile= Specifies the path and file name for the input file. Enclosing the value in double quotes is recommended.This parameter is required.

/delim= Specifies the delimiter. Specify one of the following values:

● Tab

● Comma

● #nnn

where #nnn represents any valid 3-digit ASCII character value (0 – 255).

Tab is the default value.

/cols= Specifies the column order. If supplied, must contain all column identifiers. A12345 is the defaultvalue.

/stripq= Specifies whether to remove quoted strings. Specify one of the following values:

● Y[es]

● N[o]

● T[rue]

● F[alse]

● 1

● 0

The default value is True.

Table 35 Blend Parameters

Parameter Description

/bl= Specifies the name of blender to run. This parameter is required.

/sver= Specifies the name (or abbrev) for the source version to blend. This parameter is required.

/tver= Specifies the name (or abbrev) for the target version to blend. This parameter is required.

/nvera= Specifies the name (or abbrev) for the new version to create.

/nverd= Specifies a description for the new version. You must enclose the value in double quotes.

/save= Specifies whether to save the blended version or leave it detached. Specify one of the followingvalues:

● Y[es], T[rue], or 1

● N[o], F[alse], or 0

The default value is False. For information on saving versions, see “Saving Versions in the BatchClient” on page 167.

/blendlog= Specifies the name of the blend log file (not the same as the Batch Client log file). The default valueis stored in the blend profile.

Command Line Syntax 169

Page 170: DRM Manual

Table 36 Close Parameters

Parameter Description

/vabbrev= Specifies the name (or abbrev) for the version to close. This parameter is required.

Table 37 Export Parameters

Parameter Description

/xtype Specifies the type of export: individual export or book. Specify one of the following values:

● E[xport]

● B[ook]

This parameter is required.

/fdate= Specifies the From date/time for transaction log exports (Optional)

/tdate= Specifies the To date/time for transaction log exports (Optional)

/outfile= Specifies the path and file name for the output file. If the output file exists, it is overwritten. Enclosingthe value in double quotes is recommended. This parameter is required.

/xname= Specifies the name of the saved export to run. This parameter is required if running a single export.

/cver= Specifies the name (or abbrev) for the current version. This parameter is required.

/pver= Specifies the name (or abbrev) for the previous version. This parameter is required.

/cvertype= Specifies the version type for the current version. Valid values are:

● A[s Of]

● N[ormal]

N[ormal] is the default.

/pvertype= Specifies the version type for the previous version. Valid values are:

● A[s Of]

● N[ormal]

N[ormal] is the default.

/casofdate= Specifies the As Of Date/Time to use when creating an As Of Version for the current version for theexport.

/pasofdate= Specifies the As Of Date/Time to use when creating an As Of Version for the previous version forthe export.

/bk= Specifies the name of the saved book to run. This parameter is required if exporting a book.Enclosing value in double quotes is recommended.

/bkcmb= Specifies whether to combine the export output into the file named in /outfile. Specify one ofthe following values:

● Y[es]

● N[o]

● T[rue]

170 Using the Data Relationship Management Batch Client

Page 171: DRM Manual

Parameter Description

● F[alse]

● 1

● 0

If this parameter is False, each export is saved in the file name stored in its export profile. Exportsfor which the file name in the export profile is invalid or for which Output is set to a value otherthan File are combined into the file named in /outfile. The default value is stored in book.

/prefile= Specifies the path and file name to prepend to a combined export book. The default value is storedin book.

/pstfile= Specifies the path and file name to append to a combined export book. The default value is storedin book.

/fhier= Specifies the From (Previous) Hierarchy. Used for Hierarchy Compare and Hierarchy Differenceexports.

/thier= Specifies the To (Current) Hierarchy. Used for Hierarchy Compare and Hierarchy Difference exports.

/fabbrev= Specifies the name (or abbrev) for the top node of the From (Previous) hierarchy. Used for HierarchyCompare and Hierarchy Difference exports.

/tabbrev= Specifies the name (or abbrev) for the top node of the To (Current) hierarchy. Used for HierarchyCompare and Hierarchy Difference exports

/hier= Specifies the name (or abbrev) for the hierarchy to export. Used for Hierarchy Export and othersimilar exports, but not used for Hierarchy Compare and Hierarchy Difference exports.

/nabbrev= Specifies the name (or abbrev) of the top node to export. Used for Hierarchy Export and other similarexports, but not used for Hierarchy Compare and Hierarchy Difference exports.

Table 38 Import Parameters

Parameter Description

/infile= Specifies the path and file name for the input file. Enclosing the value in double quotes isrecommended. This parameter is required.

/iabbrev= Specifies the name (or abbrev) for the import to run. This parameter is required.

/implog= Specifies the name of the import log file (not the same as the Batch Client log file.) The default valueis stored in the import profile.

/vabbrev= Specifies the version name (or abbrev) to be created by import. The default value is stored in theimport profile.

/vdescr= Specifies the description of the version to be created by import. The default value is stored in theimport profile.

/save= Specifies whether to save the imported version or leave it detached. Specify one of the followingvalues:

● Y[es]

● N[o]

● T[rue]

Command Line Syntax 171

Page 172: DRM Manual

Parameter Description

● F[alse]

● 1

● 0

The default value is False.

For information on saving versions, see “Saving Versions in the Batch Client” on page 167.

Table 39 Open Parameters

Parameter Description

/vabbrev= Specifies the name (or abbrev) of the version to open. This parameter is required.

Table 40 Refresh Parameters

Parameter Description

/vabbrev= Specifies the name (or abbrev) of the version to refresh (close and re-open). This parameter is required.

Table 41 Delete Parameters

Parameter Description

/vabbrev= Specifies the name (or abbrev) for the version to delete. This parameter is required.

Configuration File SyntaxIn addition to using command-line parameters, the Batch Client can be run with a configurationfile. Configuration files are formatted like INI files, with sections, keys, and values. There is aGeneral section and an additional section for the specific operation. Section names are enclosedin brackets ( [ ] ) and can be any string value but must match the value specified by the operationkey. Lines within each section are formatted in key=value pairs.

Below is an example configuration file.

[General]Operation=ExportUserName=myloginPassword=mypasswordURL=http://localhost/MDM/LogFileName=C:\Hyperion\Master Data Management\rdsc.log[Export]ExportType=ExportExportName=WeeklyExportOutFile= C:\Hyperion\Master Data Management\export_data.txtCurrentVersionAbbrev=COA Apr 2004PrevVersionAbbrev=COA Mar 2004

A configuration file can include multiple operations. Each operation is contained in a separatesection with a unique label. A special section labeled [Operations] is used to specify the number

172 Using the Data Relationship Management Batch Client

Page 173: DRM Manual

of operation sections in the file and the label for each. The operations are performed in the orderlisted.

Below is an example of a configuration file with multiple operations. Note that when usingmultiple operations, the operation key, for example Operation=Import, must be included ineach section rather than just once in the General section.

Note:

Sections, keys, and values are not case sensitive.

[General]Operation=MultipleUserName=myloginPassword=mypasswordURL=http://localhost/MDM/LogFileName=C:\Hyperion\Master Data Management\rdsc.log[Operations]OperationCount=3Operation1=Weekly_ImportOperation2=Update_CostCentersOperation3=Merge_Data[Weekly_Import]Operation=ImportInFile="COA_data.txt"ImportAbbrev="RDSC Import"ImportLogFileName="C:\Hyperion\Master Data Management\MDMConnect\import_log.txt"VersionAbbrev="COA Current"VersionDescription="COA for this month"[Update_CostCenters]Operation=AutomateInFile=CostCenter_changes.txtStripQuotedStrings=TrueDelimiter=comma[Merge_Data]Operation=BlendBlendname="COA Blender"SourceVersionAbbrev="COA Current"TargetVersionAbbrev="COA Previous"NewVersionAbbrev="COA Blended"NewVersionDescription="Current and Previous COA"

The following tables describe the keys that can be used in each section of the configuration file.

Table 42 General Section of Configuration File

Key Description

Operation Specifies the operation to perform. Specify one of the following values:

● M[ultiple]

● A[utomate]

● B[lend]

Configuration File Syntax 173

Page 174: DRM Manual

Key Description

● C[lose]

● E[xport]

● I[mport]

● O[pen]

● R[efresh]

● D[elete]

This key is required

UserName Specifies the Data Relationship Management user name for login. This key is required.

Password Specifies the Data Relationship Management password for login. This key is required.

URL Specifies the URL (including http:// or https://) for the Web server hosting Data RelationshipManagement. For example, "http://www.myserver.com/mdm_ntier"

Note that this is the same URL used when defining login connections for the N-tier client. Enclosingthe value in double quotes is recommended.

This key is required.

LogFileName Specifies the path and file name for the log file. If the file exists, the log is appended to the end ofthe existing file. Enclosing the value in double quotes is recommended.

The default file name is MDMConnectMMDDYYYY.log, where MM = month, DD = day, YYYY =year

Table 43 Multiple Section of Configuration File

Key Description

OperationCount Specifies the number of operation sections in the file. Specify an integer greater than 0. Thiskey is required.

OperationN Specifies the label for an operation section where N is a number between 1 and theOperationCount value. This key is required.

Table 44 Automate Section of Configuration File

Key Description

InFile Specifies the path and file name for the input file. Enclosing the value in double quotesis recommended. This key is required.

StripQuotedStrings Specifies whether to remove quoted strings. Specify one of the following values:

● Y[es]

● N[o]

● T[rue]

● F[alse]

● 1

● 0

The default value is True.

174 Using the Data Relationship Management Batch Client

Page 175: DRM Manual

Key Description

Delimiter Specifies the delimiter. Specify one of the following values:

● Tab

● Comma

● #nnn

where #nnn represents any valid 3-digit ASCII character value (0 – 255).

Tab is the default value.

ColumnOrder Specifies the column order. If supplied, must contain all column identifiers. A12345 isthe default value.

Table 45 Blend Section of Configuration File

Key Description

BlendName Specifies the name of blender to run. This key is required.

BlendLogFileName Specifies the name of the blend log file (not the same as the Batch Client log file).The default value is stored in the blend profile.

SourceVersionAbbrev Specifies the name (or abbrev) for the source version to blend. This key is required.

TargetVersionAbbrev Specifies the name (or abbrev) for the target version to blend. This key is required.

NewVersionAbbrev Specifies the name (or abbrev) for the new version to create.

NewVersionDescription Specifies a description for the new version. You must enclose the value in doublequotes.

AutoSave Specifies whether to save the blended version or leave it detached. Specify one ofthe following values:

● Y[es]

● N[o]

● T[rue]

● F[alse]

● 1

● 0

The default value is False.

For information on saving versions, see “Saving Versions in the Batch Client” on page167.

Table 46 Close Section of Configuration File

Key Description

VersionAbbrev Specifies the name (or abbrev) for the version to close. This key is required.

Configuration File Syntax 175

Page 176: DRM Manual

Table 47 Export Section of Configuration File

Key Description

ExportType Specifies the type of export: individual export or book. Specify one of the followingvalues:

● E[xport]

● B[ook]

This key is required.

OutFile Specifies the path and file name for the output file. If the output file exists, it isoverwritten. Enclosing the value in double quotes is recommended. This key isrequired.

ExportName Specifies the name of the saved export to run. This key is required if running a singleexport.

CurrentVersionAbbrev Specifies the name (or abbrev) for the current version. If not specified, the name ofthe default version is used.

PrevVersionAbbrev Specifies the name (or abbrev) for the previous version. If not specified, the name ofthe default version is used.

BookName Specifies the name of the saved book to run. This key is required if exporting a book.Enclosing value in double quotes is recommended.

CombineExportOutput Specifies whether to combine the export output into the file named in /outfile.Specify one of the following values:

● Y[es]

● N[o]

● T[rue]

● F[alse]

● 1

● 0

If this parameter is False, each export is saved in the file name stored in its exportprofile. Exports for which the file name in the export profile is invalid or for which Outputis set to a value other than File are combined into the file named in /outfile. Thedefault value is stored in book.

PreFileName Specifies the path and file name to prepend to a combined export book. The defaultvalue is stored in book.

PostFileName Specifies the path and file name to append to a combined export book. The defaultvalue is stored in book.

FromHierarchy Specifies the From (Previous) Hierarchy. Used for Hierarchy Compare and HierarchyDifference exports.

ToHierarchy Specifies the To (Current) Hierarchy. Used for Hierarchy Compare and HierarchyDifference exports.

FromTopNodeAbbrev Specifies the name (or abbrev) of the top node of the From (Previous) hierarchy. Usedfor Hierarchy Compare and Hierarchy Difference exports.

176 Using the Data Relationship Management Batch Client

Page 177: DRM Manual

Key Description

ToTopNodeAbbrev Specifies the name (or abbrev) of the top node of the To (Current) hierarchy. Used forHierarchy Compare and Hierarchy Difference exports

HierarchyCount Specifies the number of hierarchy/top node pairs defined.

Hierarchyn Specifies the Hierarchy to export, where n is a number (1 through HierarchyCount)identifying the current hierarchy/top node pair (for example, Hierarchy1). Used forHierarchy Export and other similar exports, but not used for Hierarchy Compare andHierarchy Difference exports.

TopNodeAbbrevn Specifies the name (or abbrev) of the top node to export, where n is a number (1through HierarchyCount) identifying the current hierarchy/top node pair (for example,TopNodeAbbrev1). Must match Hierarchyn. Used for Hierarchy Export and other similarexports, but not used for Hierarchy Compare and Hierarchy Difference exports.

FromDate Specifies the From date/time for transaction log exports (Optional)

ToDate Specifies the To date/time for transaction log exports (Optional)

CurrentVersionType Specifies the version type for the current version. Valid values are:

● A[s Of]

● N[ormal]

The default is N[ormal].

CurrentAsOfDate Specifies the As Of Date/Time to use when creating an As Of Version for the currentversion for the export.

PrevVersionType Specifies the version type for the previous version. Valid values are:

● A[s Of]

● N[ormal]

The default is N[ormal].

PrevAsOfDate Specifies the As Of Date/Time to use when creating an As Of Version for the previousversion for the export.

Table 48 Import Section for Configuration File

Key Description

InFile Specifies the path and file name for the input file. Enclosing the value in double quotesis recommended. This key is required.

ImportAbbrev Specifies the name (or abbrev) for the import to run. This key is required.

ImportLogFileName Specifies the path and file name of the import log file. This is not the same log file asdefined by the LogFileName key in the [General] section.) The default file name isMDMConnectImportMMDDYYYY.log, where MM = month, DD = day, YYYY = year

VersionAbbrev Specifies the version name (or abbrev) to be created by import. The default value is storedin the import profile.

VersionDescription Specifies the description of the version to be created by import. The default value isstored in the import profile.

Configuration File Syntax 177

Page 178: DRM Manual

Key Description

AutoSave Specifies whether to save the imported version or leave it detached. Specify one of thefollowing values:

● Y[es]

● N[o]

● T[rue]

● F[alse]

● 1

● 0

The default value is False.

For information on saving versions, see “Saving Versions in the Batch Client” on page167.

Table 49 Open Section for Configuration File

Key Description

VersionAbbrev Specifies the name (or abbrev) of the version to open. This key is required.

Table 50 Refresh Section of Configuration File

Key Description

VersionAbbrev Specifies the name (or abbrev) of the version to refresh (close and re-open). This key is required.

Table 51 Delete Section of Configuration File

Key Description

VersionAbbrev Specifies the name (or abbrev) for the version to delete. This parameter is required.

Outputs and Result CodesAll Batch Client operations generate a log file. In addition, exports generate an exported datafile and an export log file. The Batch Client logs warnings in the log file for any script items thatfail. All errors are also recorded in the log file, including the complete error message.

In addition, the Batch Client returns an error level (exit code or result code) indicating its successor failure. Error levels can be tested by a scheduling program or batch file and appropriate actioncan automatically be taken.

Table 52 Error Level Values

Error Level Value Description

0 Successful/normal termination

1 Unknown error

178 Using the Data Relationship Management Batch Client

Page 179: DRM Manual

Error Level Value Description

2 One or more results from an Automator operation returned a failure

3 Error returned from a Blender operation

100 Error encountered by Data Relationship Management engine and returned to the Batch Client

200 Error occurred during initialization of the Batch Client

210 An invalid parameter value was passed

220 Invalid URL

230 Invalid user name or password

Outputs and Result Codes 179

Page 180: DRM Manual

180 Using the Data Relationship Management Batch Client

Page 181: DRM Manual

13Using Data Relationship

Management Web Publishing

In This Chapter

Overview ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 181

Web Server Commands ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 182

Using Web Client Features ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 183

Main Toolbar and Hierarchy Window ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 184

Frequently Asked Questions ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 189

OverviewThe Data Relationship Management Web Publishing module provides an auxiliary means ofaccessing Data Relationship Management system functionality. This application provides thefollowing capabilities through a Web browser interface:

● Viewing hierarchies and node properties

● Running exports

● Printing hierarchy trees

● Searching for nodes in a given hierarchy

Data Relationship Management Web Publishing connects to the Data Relationship Managementapplication server, but operates in a read-only mode. Various requests can be made using HTTPto either retrieve information or execute a command such as running exports or reloading fromthe database.

Figure 80 on page 182 provides a top-level view of Data Relationship Management WebPublishing in relation to the Data Relationship Management architecture.

Web Publishing can be run on its own server or hosted on the Data Relationship Managementmulti-tier Web Server or the primary application server.

Overview 181

Page 182: DRM Manual

Figure 80 Data Relationship Management Web Publishing Architecture

Web Server CommandsYou interact with the Data Relationship Management Web Publishing engine by usingcommands sent via a browser. The available commands are listed in the table below. Thecommands are entered in a URL format:

http://webservername/mdm_web/mdm_web_pub_gateway.dll/command[?

param=value]

where webservername is the Web server name and command is the desired command andparam is the parameter and value is the parameter value.

Example: http://localhost/mdm_web/mdm_web_pub_gateway.dll/ListHiers?Version=Test%20Import

Table 53 Web Server Commands

Command Description Parameters

ListVersions Returns the versions available for WebPublishing. This list is controlled by the WebVersand WebVersionList system preferences.

{None}

ListHiers Returns the hierarchies for a specified version. Version

ListProperties Returns the full set of properties available forWeb Publishing. Returns abbrev, description,label, data type, Categories tab delimited.

{None}

182 Using Data Relationship Management Web Publishing

Page 183: DRM Manual

Command Description Parameters

ListNodeProps Returns property values for a specified node.Returns proper abbrev, Value tab delimited

Version, Hier, Node

RunExport Runs a specified export available to WebPublishing.

Export ID, CurrentVersion, PreviousVersion

TopNode Returns the top node of a hierarchy. Version, Hier

ListExports Lists the exports available for Web Publishing.Returns the export type, export abbrev, ExportProfiles tab delimited

{None}

FindNode Finds a specified Node. Returns Node,Excluded Flag, Inactive Flag

Version, Hier, Node

ExpandHier Returns the Descendants of the specified nodedown to the specified level limit. The ReturnString contains Level, Node Abbrev, Limb/LeafIndicator, Child Count, Node Description, NodeDisplay Name, Inactive Flag

Version, Hier, Node, levellimit

ListExportTypes Lists the Export Types Available for WebPublishing

{None}

ShowExport Returns the Export text for an export that hasbeen run. The Export contents are streamed.

ExportID, CurrentVersion, PreviousVersion

ListStdExports Lists the Standard Exports available for WebPublishing. Returns the Export Type, ExportAbbrev and Export Profiles Tab Delimited

{None}

SearchForNode Returns a set of nodes that matches a searchcriteria. Returns the Node Abbrev, [PropertyValue Searched on, If not Abbrev], ExcludedFlag, Inactive Flag

Version, Hier, SearchProp, SearchText

GetSysPrefValue Returns the Value of the specified systempreference

SystemPrefName

InitEngine Initializes the Engine (Called by the service onstartup)

{None}

RefreshProps Refreshes the Property List. Can be used tohave Web Publishing see new propertieswithout restarting Web Publishing

{None}

Using Web Client Features

➤ To open a Data Relationship Management Web client, type the following URL into the addressbox of your browser:

http://webservername/mdm_web

Using Web Client Features 183

Page 184: DRM Manual

where webservername is the Web server running the Data Relationship Management Webcomponents.

The Data Relationship Management Web client home page is displayed.

Main Toolbar and Hierarchy WindowThe main toolbar displayed within the client window contains the following items.

● Version list - select one of the available Data Relationship Management versions

● Hierarchy list - select a hierarchy from within the selected version

● Node name buttons (3) - choose how nodes are labeled in the hierarchy tree

● Show Inactive - show or hide inactive nodes in the hierarchy tree

Selecting Versions and HierarchiesThe desired Data Relationship Management Version can be selected from the Versions drop-down list at the top left of the window. A Hierarchy from within the selected version can thenbe chosen from the Hierarchies list. Once a hierarchy is selected, a tree view is displayed in theleft frame of the window.

The displayed hierarchy tree is navigated as follows:

● Clicking the plus sign (+) to the left of a node to expand that node to the next level of thehierarchy

● Clicking the minus sign (-) to the left of an expanded node to remove the display of anynodes at a lower level in the hierarchy

The display of the node names can be adjusted by selecting one of the node name buttons onthe toolbar:

● Default—Displays the value determined by the hierarchy property (for example,DefaultDisplayBy) if one is set.

184 Using Data Relationship Management Web Publishing

Page 185: DRM Manual

● Description—Displays the Description for each node.

● Default and Description—Displays both Default display value and Description for eachnode.

If none of the three buttons is selected, then the Name for each node is displayed.

The Show Inactive option can be used to either include or exclude inactive nodes from thedisplayed hierarchy tree.

The display on the right side of the Web Client is determined by the feature tab currently selected.These four options are available:

● Properties—Display properties for the currently selected node.

● Export—Display saved exports available on the Web Client.

● Print —Send image of the current hierarchy tree to a printer.

● Find—Search for a node in current hierarchy.

PropertiesWhen the Properties tab is selected on the right-hand pane, a read-only view of the propertiesfor the currently selected node is displayed. Clicking each of the available property category tabsdisplay the properties within that category. Each of the properties to which the Web user hasaccess are displayed with the exception of any excluded by way of the WebExcludeNodePropssystem preference. Clicking a property in the property viewer causes its Description to bedisplayed in the status bar below.

ExportsWhen the Exports tab is selected on the right-hand pane, a list of each available export type, andany saved exports, are displayed in the tree view.

Main Toolbar and Hierarchy Window 185

Page 186: DRM Manual

Figure 81 Exports

The only exports visible in the Web client are those contained in the export book specified bythe WebBook system preference. If this system preference is not set or not set correctly, then allexports visible to the Web user are available on the Web client.

To run an export, select it in the tree and click the Request Export Run button. The VersionSelector window is displayed. Select a version (or select the check box to use the current defaultversion) and then select a previous version if applicable to the desired export type. Click the OKbutton to send the request.

A confirmation message is displayed to confirm that the request for the export has beensubmitted to the Data Relationship Management Web Server.

When the export completes, a new node is displayed in the tree representing the output of thejob. This node is labeled with the name of the export and the current and previous versions thatwere used.

Note:

It may be necessary to click the Refresh Export List button to update the tree and display thelatest results.

The result files are stored on the Web server in the directory specified by the WebExDir systempreference. To retrieve the export results, select the output node for the export and click theDownload Export button. Specify a filename for saving the results and click Save.

Note:

For exports configured to output to a database table, no output is displayed on the Web clientnor is anything available for download.

186 Using Data Relationship Management Web Publishing

Page 187: DRM Manual

PrintWhen the Print tab is selected on the right-hand pane, options for printing hierarchy trees aredisplayed.

Figure 82 Printing Hierarchy Trees

The hierarchy currently shown in the left frame can be printed with the following options:

● Full Hierarchy—Prints the entire hierarchy.

● From Selected Node—Prints the hierarchy from the selected node including all descendantnodes.

● As Shown In Tree—Prints the hierarchy with the nodes currently selected and expanded inthe left frame tree view.

● Contents of Memo—Prints the contents of the preview window including annotations.

Click the Preview button to display the results of the selected print option in the preview windowin the right-hand pane. Additional text can also be typed into the preview window to annotatethe hierarchy. Selecting the Contents of Memo option prints the hierarchy data along with anyadded text.

Click the Print It button to send the appropriate text to the default printer for the local machine.

FindThe Find function can be used to locate a node in the selected version and hierarchy using asearch string. The WebFindFunction system preference determines which mode will be available:Basic or Enhanced. In the Enhanced mode, the nodes can be searched by:

● Name

● Description

● Other—Any string property within the hierarchy

Main Toolbar and Hierarchy Window 187

Page 188: DRM Manual

The list of properties available for searching can be restricted if desired. Using the DataRelationship Management client tool, the hierarchy level property WebFindProps can be setto a list of the properties to be used. Then only the properties in that list is displayed in thedrop-down list for this option. If the WebFindProps property has no value or does not exist,then all string properties is available in the list.

Tip:

Creating the hierarchy-level property WebFindProps as data type NodeProps makes it easierfor users to enter the desired list of properties.

The search text can also include wildcard characters. If you include an asterisk (*) before or afterthe search text, all values that contain the specified substring are returned.

Enter the appropriate text in the Search Text box and then click the Find button.

Figure 83 Enhanced Search

The list of nodes matching the search criteria is displayed in Search Results box. Selecting a nodefrom the results and clicking the Go To button highlights the given node in the hierarchy tree.The Clear Results button can be used to erase the contents of the Search Results box.

188 Using Data Relationship Management Web Publishing

Page 189: DRM Manual

In the Basic mode, nodes can be searched by name only and the search text must exactly matchthe name.

Figure 84 Basic Search

Frequently Asked Questions

How do I display the home page after I install or update DataRelationship Management Web Publishing?If the Data Relationship Management Web Publishing home page is not displayed after youinstall or upgrade the software, follow this sequence of steps to resolve the problem:

1. Verify that the user name and password entered with the Web Publishing Console arecorrect.

If the Web Publishing login information is invalid, a “Catastrophic failure” message may bedisplayed. While this message may sound severe, it simply means that the Engine could notsuccessfully login to the database server.

2. Verify that the URL entered in the browser is correct and has the following format: http://webservername/mdm_web.

3. Verify network connectivity to the Web server computer as follows:

a. Select Start, then Programs, then Accessories, then Command Prompt.

b. Enter the following command:

ping Host

where Host is the name of the Web server.

4. Verify that a reply is received from the application server.

5. If no valid reply is received, then check all network connections between the client and servermachines.

6. Verify that the Web server is running and IIS is started.

Frequently Asked Questions 189

Page 190: DRM Manual

How do I start the Data Relationship Management Webengine?The Data Relationship Management Web engine loads automatically when the service is started.You can start and stop the service using the Web Publishing Console or the Microsoft Servicesscreen.

How do I check for error messages?Any time an unexpected condition arises, an entry is logged into the Windows Event Viewerunder Application. The Web Publishing Console can be used to see the filtered set of event logmessages pertaining to Web Publishing.

➤ To manually check for error messages:

1 Select Start, then Programs, then Administrative Tools, then Event Viewer.

2 Select the Application Log node or the System Log node.

3 Look for any error messages in the list on the right side of the Event Viewer.

4 If you find errors, double-click the row to view details of which application caused the error and the specificproblem encountered.

How do I check for connectivity with the Data RelationshipManagement application server?The Web Publishing Console provides a Web Server tab that displays the versions accessiblefrom the Data Relationship Management application server. If this screen displays versions thenthere is connectivity to the Data Relationship Management application server. Note you mayhave to right click and say refresh if you are restarting services so that the cached value shownis refreshed.

190 Using Data Relationship Management Web Publishing

Page 191: DRM Manual

AAccessibility

In This Appendix

Enabling Accessibility. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 191

Enabling Keyboard Equivalents.. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 191

This appendix describes Data Relationship Management accessibility features.

Enabling AccessibilityData Relationship Management is always in accessibility mode and does not need to be enabled.

Enabling Keyboard EquivalentsRight-click menus can be accessed by pressing Shift+F10.

Use the following keyboard shortcuts to open options in the Data Relationship ManagementFile menu.

Table 54 File Menu Keyboard Shortcuts

Menu Option Keyboard Equivalent

Automator Alt+F, A

Export Alt+F, E

Blender Alt+F, B

Import Alt+F, I

The following keyboard shortcuts open options in the Data Relationship Management Adminmenu.

Table 55 Admin Menu Keyboard Shortcuts

Menu Option Keyboard Equivalent

Node Access Groups Alt+A, A

Enabling Accessibility 191

Page 192: DRM Manual

Menu Option Keyboard Equivalent

Node Types Alt+A, N

Node Type Glyphs Alt+A, G

Properties Alt+A, P

Property Categories Alt+A, C

System Categories Alt+A, Y

System Preferences Alt+A, S

User Management Alt+A, U

Validations Alt+A, V

The following keyboard shortcuts open options in the Data Relationship Management Toolsmenu.

Table 56 Tools Menu Keyboard Shortcuts

Menu Option Keyboard Equivalent

Property Query Alt+T, P

Compare Alt+T, C

Property Compare Alt+T, R

Renamed Node Compare Alt+T, N

Synchronize, By Property Alt+T, S, R

Synchronize, ByName Alt+T, S, N

Change Password Alt+T, A

Transaction History Alt+T, H

Options Alt+T, O

Request History Alt+T, Q

The following keyboard shortcuts open options in the Data Relationship Management hierarchywindow right-click menu.

Note:

For most of the following menu options, the version must be expanded and selected for thekeyboard equivalent to work.

192 Accessibility

Page 193: DRM Manual

Table 57 Hierarchy Window Right-Click Menu Keyboard Shortcuts

Menu Option Keyboard Equivalent

Properties Ctrl+O, F11

Synchronize By Ctrl+O, Tab, select node using arrow keys, Ctrl+S

Take Ctrl +O, tab, select node using arrow keys, Shift +F10, T

Put Ctrl +O, tab, select node using arrow keys, Shift +F10, P

Add Node Ctrl +O, tab, select node using arrow keys, Shift +F10, A

Insert Node Ctrl+O, select a limb node using arrow keys, Ctrl+I

Model After Ctrl+M

Copy Properties Shift+Ctrl+C

Paste Properties Shift+Ctrl+V

Inactivate F12

Reactivate Ctrl+F12

Remove Ctrl+R

Delete Ctrl+D

Move to Previous Node Shift+F10, M

Expand From Here Shift+F10, E

Lists, Ancestors Ctrl+O, Shift+F10, L, A

Lists, Siblings Ctrl+O, Shift+F10, L, S

Lists, Children Ctrl+O, Shift+F10, L, C

Lists, Links Ctrl+O, Shift+F10, L, L

Verify, Assigned Ctrl+O, Shift+F10, F, A

Verify, Selected Ctrl+O, Shift+F10, F, S

Transaction History (Node) Ctrl+O, Shift+F10, H

The following keyboard shortcuts open options in the Oracle Hyperion Data RelationshipManagement, Fusion Edition version and hierarchy right-click menu.

Table 58

Menu Option Keyboard Equivalent

New, Version Shift+F10, W, V

New, Hierarchy Shift+F10, W, H

Enabling Keyboard Equivalents 193

Page 194: DRM Manual

Menu Option Keyboard Equivalent

Open All Shift+F10, L

Open Selected Shift+F10, S

Open Baseline Shift+F10, B

Close Version Shift+F10, C

Close All Alt+F, L

Close Baseline Shift+F10, I

Copy to New Shift+F10, P

Create As Of Shift+F10, E

Delete Shift+F10, D

Properties Shift+F10, R

Assign, Validation Shift+F10, A, V

Assign, Verification Shift+F10, A, R

Verify, Assigned Shift+F10, V, A

Verify, Selected Shift+F10, V, S

Verification Messages Shift+F10, M

Clear Verify Results Shift+F10, F

List, Global Nodes Shift+F10, T, G

List, Orphan Nodes Shift+F10, T, R

Show Status Column Shift+F10, H

194 Accessibility

Page 195: DRM Manual

Index

Aaccessibility, 191actions in Automator, 87Activate, 38allocating users

node access groups, 67property categories, 67

ancestor export, 123annulling a node, 53Automator, 48

defined, 18flat file format, 86import errors, 86required parameters, 89running imports, 83supported actions, 87

Bbatch client

command line syntaxall operations, 168automate parameters, 169blend parameters, 169close parameters, 170delete parameters, 172export parameters, 170import parameters, 171open parameters, 172refresh parameters, 172

configuration file syntax, 172automate section, 174blend section, 175close section, 175delete section, 178export section, 176general section, 173import section, 177

multiple section, 174open section, 178refresh section, 178

dependencies, 167outputs and result codes, 178overview, 165saving versions, 167

Blenderdefined, 18elements, 93setting up top nodes, 98setting up versions and hierarchies, 95viewing results, 102

Blender wizardstarting, 94

Ccompare, 149

defined, 19property, 20renamed node, 20types, 20

controlling hierarchy, 17creating a new login connection, 24custom sort order, 57

DData Relationship Management

changing password, 25starting, 23

defined, 18deleting a node, 52duplicate handling, 78

Eexclusion filter

A B C D E F G H I K L M N O P R S T V

Index 195

Page 196: DRM Manual

export, 125export

defined, 19export books, 133export classes, 105export to table, 128export wizard

ancestor export, 123column width, 113exclusion filter, 125export books, 133export to table, 128generation, 114hierarchy compare, 116hierarchy difference report, 117hierarchy export, 118lookup export, 120merge log export, 121output destination, 128output formatting, 126output page, 128select columns, 109starting, 106top nodes, 107transaction log export, 122verifications and filters, 124version export, 123

Ffile format

import, 75flat file format in Automator, 86

Ggeneration

export, 114global node, 16

Hhierarchy

defined, 15working with, 38

hierarchy compareexport, 116

hierarchy difference reportexport, 117

hierarchy export, 118hierarchy properties, 65

Iimport, 18

elements, 69sections, 70

import errors, 86import file format, 75import mappings, 74import processing options, 72import results, 80import wizard

duplicate handling, 78file format, 75naming the import version, 71setting up mappings, 74setting up sections and processing options, 72starting, 70

Inactivate, 38inactivating a node, 53inheritance

defined, 17

Kkeyboard equivalents, 191

Llocal node, 16login connection

creating new, 24lookup export, 120

Mmemory status, 34merge log export, 121Model, 48Model After, 48Model Nodes, 48

Nnaming the import version, 71node

defined, 15working with, 38

A B C D E F G H I K L M N O P R S T V

196 Index

Page 197: DRM Manual

node access groupsallocating users, 67

nodesannulling, 53deleting, 52inactivating, 53orphan, 54reactivating, 53removing, 53

Oorphan node, 54output destination

export, 128output formatting

export, 126output page

export, 128

Pparameters in Automator, 89properties

hierarchy, 65working with, 58

propertydefined, 16

property categoriesallocating users, 67

property category, 59property compare, 20property editor, 58property status, 62

Rreactivating a node, 53referential integrity

defined, 16removing a node, 53renamed node compare, 20running Automator imports, 83running validations, 138running verifications, 138

Sselecting columns

export, 109setting column widths

export, 113setting up duplicate handling, 78setting up import mappings, 74setting up import sections and processing options,

72setting up top nodes in Blenders, 98sort order

custom, 57specifying file format, 75speed buttons, 26starting Data Relationship Management, 23starting export wizard, 106starting import wizard, 70system architecture, 13

Ttop nodes

export, 107transaction log export, 122

Vvalidations

defined, 137running, 138

verificationsdefined, 137running, 138viewing results, 140

verifications and filtersexport, 124

versiondefined, 14status, 15

version and hierarchies in Blenders, 95version control window, 33version export, 123version status, 34viewing Blender results, 102viewing import results, 80viewing results of verifications, 140

A B C D E F G H I K L M N O P R S T V

Index 197

Page 198: DRM Manual

A B C D E F G H I K L M N O P R S T V

198 Index