vrealize business installation and administration guide ... · using or linking veritas netbackup...

90
vRealize Business Installation and Administration Guide vRealize Business Advanced or Enterprise 8.2 This document supports the version of each product listed and supports all subsequent versions until the document is replaced by a new edition. To check for more recent editions of this document, see http://www.vmware.com/support/pubs. EN-001593-00

Upload: others

Post on 25-Mar-2020

3 views

Category:

Documents


0 download

TRANSCRIPT

Page 1: vRealize Business Installation and Administration Guide ... · Using or Linking Veritas NetBackup with vRealize Business 54 ... vRealize Business Installation and Administration Guide

vRealize Business Installation andAdministration Guide

vRealize Business Advanced or Enterprise 8.2

This document supports the version of each product listed andsupports all subsequent versions until the document isreplaced by a new edition. To check for more recent editionsof this document, see http://www.vmware.com/support/pubs.

EN-001593-00

Page 2: vRealize Business Installation and Administration Guide ... · Using or Linking Veritas NetBackup with vRealize Business 54 ... vRealize Business Installation and Administration Guide

vRealize Business Installation and Administration Guide

2 VMware, Inc.

You can find the most up-to-date technical documentation on the VMware Web site at:

http://www.vmware.com/support/

The VMware Web site also provides the latest product updates.

If you have comments about this documentation, submit your feedback to:

[email protected]

Copyright © 2014 VMware, Inc. All rights reserved. Copyright and trademark information.

VMware, Inc.3401 Hillview Ave.Palo Alto, CA 94304www.vmware.com

Page 3: vRealize Business Installation and Administration Guide ... · Using or Linking Veritas NetBackup with vRealize Business 54 ... vRealize Business Installation and Administration Guide

Contents

About This Book 7

Installation Procedure

1 Preparing to Install vRealize Business 11Oracle Parameter Values 11Creating Tablespaces 12Create Oracle Users 13Set the UNIX or LINUX Configuration 13About Installing vRealize Business in a cluster environment 14

2 Install vRealize Business 15

Run vRealize Business Installer 16Select the Installation Mode 17Select the Installation Type 17Select the Database Schema configuration 18Select a Source for the Database Schema Content 18Select Installation Procedures 19Select Applications to Install 19Select a System Type 20Provide Server Parameters for the Application Server 21Configure Oracle Database Parameters 22Define a User Authentication Type 23Define a Lightweight Directory Access Protocol Connection 24LDAP Synchronization for Users or Groups 25Create an User for Logging in to vRealize Business 25Select an Application File for vRealize Business installation 26Content Packages in vRealize Business 26Select Content Packages 27Configure Advanced Settings 27Configure a Mail Distributor 28Complete the Installation Procedure 29vRealize Business Advanced or Enterprise with vRealize Business Standard Integration Activation

Procedure 29

3 Upgrading and Custom Installations 33

Upgrade vRealize Business Application and Database 33Upgrade the vRealize Business Application 35Upgrade the Database 36Custom Installation 37Update the Java Runtime Environment Version 38

VMware, Inc. 3

Page 4: vRealize Business Installation and Administration Guide ... · Using or Linking Veritas NetBackup with vRealize Business 54 ... vRealize Business Installation and Administration Guide

4 Configuration Files 39

Working with Configuration Files in vRealize Business 39ServiceFlow Properties 39About Flat Files 39Batch Procedure Whitelist Properties 40vRealize Business Key 40vRealize Business License 41

Post-Installation Procedure

5 Post Installation Tasks 45Log In to vRealize Business 45Verify Basic vRealize Business Features 46Configure Email Settings 46Set the Time Zone 47Oracle Parameters Customized for vRealize Business 47Encrypting Passwords 48Enable Data Table Archiving 49Sending Traps with SNMP 49Enabling SSL for Tomcat 50Test the SSL Configuration 51Verifying Character Compatibility 51Supporting Lotus Notes 52Configure vRealize Business Cluster Installation 52

6 Backup and Recovery 53

Backup Strategies 53Oracle Database Backups 54Using or Linking Veritas NetBackup with vRealize Business 54Recovery 54

7 Planning Requirements for vRealize Business 57

Factors Affecting the Disk Capacity Calculation 57Configuring the Database Disk 58RAID Devices 59

8 Creating RTF Templates 61

Dynamic Tag Library 61Agreement Documentation Tags 62Report Documentation Tags 66Advanced Options 69Troubleshooting the RTF Template 70

Administration Procedure

vRealize Business Installation and Administration Guide

4 VMware, Inc.

Page 5: vRealize Business Installation and Administration Guide ... · Using or Linking Veritas NetBackup with vRealize Business 54 ... vRealize Business Installation and Administration Guide

9 Configuring vRealize Business System Parameters 75Infrastructure Configuration Parameters 75Dimensions Configuration Parameters 77Database-Related Configuration Parameters 77Engine-Related Configuration Parameters 78Security Configuration Parameters 80

10 Troubleshooting vRealize Business 81

User Cannot Access vRealize Business Application 81Adaptors Fail when You Import Data from an SQL Table 82No Data in Database Adaptor for a Non-Oracle Server 82Flow Calculations are not Visible 82No Data Passes through the Identify Operator 83Unable to View Existing Reports 83Not Receiving Email for Report Distributions 83Unable to Send Email to Lotus Notes Users 84Unable to Synchronize LDAP and Active Directory Users 84Failed to Create a Document 85

Index 87

Contents

VMware, Inc. 5

Page 6: vRealize Business Installation and Administration Guide ... · Using or Linking Veritas NetBackup with vRealize Business 54 ... vRealize Business Installation and Administration Guide

vRealize Business Installation and Administration Guide

6 VMware, Inc.

Page 7: vRealize Business Installation and Administration Guide ... · Using or Linking Veritas NetBackup with vRealize Business 54 ... vRealize Business Installation and Administration Guide

About This Book

The vRealize Business Advanced and Enterprise Installation and Administration Guide provides information aboutinstalling, upgrading, configuring, customizing, backing up and recovering procedures. It also providesinformation about post-installation procedure, which includes backup and recovery, planning capacity,administrative tasks and troubleshooting vRealize Business.

Intended AudienceThis information is intended for users who wants to install, upgrade or perform post installation tasks onvRealize Business. The information is written for experienced Windows, UNIX, and Linux systemadministrators.

VMware Technical Publications GlossaryVMware Technical Publications provides a glossary of terms that might be unfamiliar to you. For definitionsof terms as they are used in VMware technical documentation, go tohttp://www.vmware.com/support/pubs.

VMware, Inc. 7

Page 8: vRealize Business Installation and Administration Guide ... · Using or Linking Veritas NetBackup with vRealize Business 54 ... vRealize Business Installation and Administration Guide

vRealize Business Installation and Administration Guide

8 VMware, Inc.

Page 9: vRealize Business Installation and Administration Guide ... · Using or Linking Veritas NetBackup with vRealize Business 54 ... vRealize Business Installation and Administration Guide

Installation Procedure

VMware, Inc. 9

Page 10: vRealize Business Installation and Administration Guide ... · Using or Linking Veritas NetBackup with vRealize Business 54 ... vRealize Business Installation and Administration Guide

vRealize Business Installation and Administration Guide

10 VMware, Inc.

Page 11: vRealize Business Installation and Administration Guide ... · Using or Linking Veritas NetBackup with vRealize Business 54 ... vRealize Business Installation and Administration Guide

Preparing to InstallvRealize Business 1

Before you install vRealize Business, you must install and configure the database.

To install vRealize Business, you must set up your machine by a creating a tablespace and Oracle users.Also, you must configure Oracle parameters. If you are using Linux or UNIX, you must configure theenvironment variables.

This chapter includes the following topics:

n “Oracle Parameter Values,” on page 11

n “Creating Tablespaces,” on page 12

n “Create Oracle Users,” on page 13

n “Set the UNIX or LINUX Configuration,” on page 13

n “About Installing vRealize Business in a cluster environment,” on page 14

Oracle Parameter ValuesThe database administrator modifies values to Oracle parameters for vRealize Business installations.

vRealize Business does not require the Oracle recycle bin. Before you run the application on a dedicateddatabase, disable this feature.

The values for the parameters are for the 64-bit version of Oracle. If you are using the 32-bit version, modifythe memory parameters as required.

Table 1‑1. Values for Oracle Parameters for vRealize Business

Parameter Description Values in Oracle Version 11g

DB_BLOCK_SIZE Specifies the size of database blocks. 8KB or 16KB for Unicode databases

DB_CACHE_SIZE Specifies the size of the default bufferpool for buffers of the primary blocksize.

Unset the parameter.

SHARED_POOL_ SIZE Specifies the size of SQL statementcache. This parameter is used toenable reuse of statements.

Unset the parameter.

LOG_BUFFER Specifies the number of buffers, eachsize of the system page located inSystem Global Area (SGA) and as aresult of the changed data written tothe redo log files.

Unset the parameter.

OPTIMIZER_ MODE Enables the Oracle Cost-BasedOptimizer when statistics areavailable.

ALL_ROWS

VMware, Inc. 11

Page 12: vRealize Business Installation and Administration Guide ... · Using or Linking Veritas NetBackup with vRealize Business 54 ... vRealize Business Installation and Administration Guide

Table 1‑1. Values for Oracle Parameters for vRealize Business (Continued)

Parameter Description Values in Oracle Version 11g

CURSOR_SHARING Specifies the type of SQL statementsthat can share the same cursors.Setting the value of this parameter toExact allows only statements withidentical text to share the same cursor.

Only the value Exact is supportedand certified.

WORKAREA_SIZE_ POLICY This parameter determines whetherOracle should automatically allocatein the Process Global Area (PGA) andSGA, or that these areas will beallocated manually.

AUTO

SESSION_CACHED_ CURSORS Specifies the number of cursors tocache per session.

5

PROCESSES Displays the maximum number ofprocesses.

200

SESSIONS Displays the maximum number ofsessions.

225

JAVA_POOL_SIZE Specifies (in bytes) the size of the Javapool, from which the Java memorymanager allocates most Java stateduring runtime execution.

Unset the parameter.

DB_WRITER_ PROCESSES The number of background databasewriter processes.

3

PGA_AGGREGATE_ TARGET Target size for the aggregate PGAmemory consumed by the instance.

Unset the parameter.

SGA_TARGET Specifies the total size of all SGAcomponents.

Unset the parameter.

SGA_MAX_SIZE Specifies the maximum size of theSGA for the lifetime of the instance.

Unset the parameter.

MEMORY_TARGET Specifies the Oracle system-wideusable memory.

5GB

MEMORY_MAX_ TARGET Unset the parameter.

Creating TablespacesOracle stores data logically in tablespaces and physically in datafiles associated with the correspondingtablespace. Before you install vRealize Business, you must create permanent tablespaces, which are used tostore user data and user created objects. You can also create temporary tablespaces that are used to storedata with short lifespan and undo tablespaces that are used to store before image data.

By using tablespaces, you can control the disk layout of an installation. A common use of tablespaces is tooptimize performance.

Table 1‑2. vRealize Business Permanent Tablespaces

Tablespace Description

DFL_DATA Main tablespace that vRealize Business uses.

DFL_IDX Default storage location for indexes.

Segments are the storage objects in the Oracle database. You can manage these segments locally withautomatic segment allocation enabled. Enable logging for these segments. Consult the databaseadministrator for appropriate sizing of the tablespaces.

vRealize Business Installation and Administration Guide

12 VMware, Inc.

Page 13: vRealize Business Installation and Administration Guide ... · Using or Linking Veritas NetBackup with vRealize Business 54 ... vRealize Business Installation and Administration Guide

The size of the undo tablespace is a product of the undo retention period and the volume of data updated byvRealize Business. The default undo retention period is 3 hours. In most cases, 10GB of undo space issufficient.

Create a temporary tablespace with an initial size of 10GB. Consult the database administrator forappropriate sizing of the tablespaces.

Create Oracle UsersEach vRealize Business installation must have an Oracle user to which all vRealize Business objects, Oracletablespaces, and procedures are associated.

Procedure

1 Create an Oracle user, for example DFL.

create user user name identified by user name;

2 Set user name_DATA as the default tablespace.

default tablespace user name_DAT temporary tablespace TEMP;

3 Grant the roles CONNECT and RESOURCES to the user.

grant connect to user name;

grant resource to user name;

4 Grant system privileges to the user.

grant create materialized view to user name;

grant create synonym to user name;

grant create view to user name;

Set the UNIX or LINUX ConfigurationBefore you install vRealize Business on a UNIX or LINUX system, configure the environment variable andkernel parameters.

Procedure

1 To define the correct file permissions to a particular user, configure an existing UNIX user profile bysetting the unmask value to 077 in /home/user/.profile and /home/user.bashrc.

2 Set the display environment variable to the IP address of the client machine on which you are working,with :0.0 appended to the address.

For example: 10.0.0.1:0.0

3 Run the System Administration Manager (SAM) and proceed to the kernel configuration.

4 Verify the minimum values for specific kernel parameters.

Parameter name Value

max_thread_proc 1024

maxfiles 256

maxusers 256

nkthread 3635

nproc 2068

ncallout 2014

5 Save this configuration and reboot.

Chapter 1 Preparing to Install vRealize Business

VMware, Inc. 13

Page 14: vRealize Business Installation and Administration Guide ... · Using or Linking Veritas NetBackup with vRealize Business 54 ... vRealize Business Installation and Administration Guide

6 Set the display environment variable again.

About Installing vRealize Business in a cluster environmentIn a cluster environment, several computers run vRealize Business and share processing by using a loadbalancer.

In a cluster installation, you can configure one computer to handle the backend processes and install theother computers in the cluster as frontend instances. See Install Application Server as a Frontend Instanceon “Configure Advanced Settings,” on page 27.

vRealize Business cluster environment is composed of three main components.

n A load balancer - to handle load distribution between available cluster nodes. For example, Apachehttpd server.

n Multiple application servers - to support several user requests. You can install Tomcat instance as amember of cluster. See “Provide Server Parameters for the Application Server,” on page 21.

n An Oracle database - to store data.

Installing vRealize Business in a cluster environment has several advantages.

n Scalability - A single application server can handle a limited number of client requests. So, you can addmultiple application servers to distribute the load, allowing concurrent users.

n Fail over recovery - In case of failure in a server to handle a client request, other severs in the clustertakes over the job to handle the requests.

n Availability - When some application servers are offline for maintenance and recovery, users can accessvRealize Business without any performance issues.

When you install vRealize Business in a cluster environment, you must perform additional configurations.See “Configure vRealize Business Cluster Installation,” on page 52.

vRealize Business Installation and Administration Guide

14 VMware, Inc.

Page 15: vRealize Business Installation and Administration Guide ... · Using or Linking Veritas NetBackup with vRealize Business 54 ... vRealize Business Installation and Administration Guide

Install vRealize Business 2To install vRealize Business, you must perform series of steps.

1 Run vRealize Business Installer on page 16You can install vRealize Business using the installer. You can perform a complete installation or selectcomponents to install.

2 Select the Installation Mode on page 17You can install vRealize Business in either evaluation mode or license mode.

3 Select the Installation Type on page 17You can select the vRealize Business installation types whether you want to perform a complete orcustom installation, upgrade, or create or upgrade only the database schema.

4 Select the Database Schema configuration on page 18During vRealize Business installation, you must determine the configuration for the database schema.

5 Select a Source for the Database Schema Content on page 18You can select the source of the database schema content. you can use the scripts or a dump file.

6 Select Installation Procedures on page 19You can select or view a list of procedures that run during the installation.

7 Select Applications to Install on page 19While installing vRealize Business, you can select applications to install such as Portfolio, SLAManager, or IT Financial Manager. If you plan to use a custom dump file for the content source, theinstallation wizard does not display the Applications page.

8 Select a System Type on page 20You can install vRealize Business on several different system types, such as single or multiplecustomers, alliance, or shared services.

9 Provide Server Parameters for the Application Server on page 21The Tomcat application servers accept different parameters.

10 Configure Oracle Database Parameters on page 22vRealize Business uses Oracle as its database server. So, you must specify database parameters duringvRealize Business installation.

11 Define a User Authentication Type on page 23During installation, you can define the authentication method by which users accessvRealize Business. The method also determines where the user credentials are stored.

VMware, Inc. 15

Page 16: vRealize Business Installation and Administration Guide ... · Using or Linking Veritas NetBackup with vRealize Business 54 ... vRealize Business Installation and Administration Guide

12 Define a Lightweight Directory Access Protocol Connection on page 24You need to define the Lightweight Directory Access Protocol (LDAP) connection, if you select theuser authentication type as LDAP during installation.

13 LDAP Synchronization for Users or Groups on page 25During installation, you can synchronize the users or groups or else the users are copied from theLDAP repository.

14 Create an User for Logging in to vRealize Business on page 25You must create a user to log in to vRealize Business. The user created during the vRealize Businessinstallation is given administrative privileges.

15 Select an Application File for vRealize Business installation on page 26You must provide the location of the application file (.war file) to install vRealize Business.

16 Content Packages in vRealize Business on page 26Content packages contain additional objects such as reports, adaptors, and role definitions, which arenot included in vRealize Business, by default.

17 Select Content Packages on page 27During installation, you can import the content packages that provide additional objects, such asreports, adaptors, and role definitions that are not included in the vRealize Business.

18 Configure Advanced Settings on page 27You can customize your installation by defining several, more complex, advanced settings options. Ifyou do not define these options during installation, you can define them later.

19 Configure a Mail Distributor on page 28To configure a mail distributor service by setting the user name and password.

20 Complete the Installation Procedure on page 29You can review your vRealize Business installation settings and complete the installation.

21 vRealize Business Advanced or Enterprise with vRealize Business Standard Integration ActivationProcedure on page 29The vRealize Business administrator can enable the integration betweenvRealize Business Advanced and Enterprise and vRealize Business Standard.

Run vRealize Business InstallerYou can install vRealize Business using the installer. You can perform a complete installation or selectcomponents to install.

Prerequisites

n Meet the hardware and software requirements. See the System Requirements Guide for additionalinformation.

n Log in to the machine as an administrator.

n Download the vRealize Business installer.

vRealize Business Installation and Administration Guide

16 VMware, Inc.

Page 17: vRealize Business Installation and Administration Guide ... · Using or Linking Veritas NetBackup with vRealize Business 54 ... vRealize Business Installation and Administration Guide

Procedure

1 Run the vRealize Business installer.

u On Windows, navigate to the vRealize Business installation files and double-click the ITBM-Installer_BuildNumber.jar file.

u On UNIX or Linux, run the <JAVA_HOME>\bin\java -jar ITBM-Installer_BuildNumber.jarcommand.

The vRealize Business installation wizard opens.

2 Click Next and click Accept the end user license agreement.

What to do next

Select the installation mode.

Select the Installation ModeYou can install vRealize Business in either evaluation mode or license mode.

Prerequisites

Run the vRealize Business installer and proceed from the Welcome screen.

Procedure

u Select an installation mode and click Next.

n Evaluation Mode. This is the default mode.

n Licensed Mode. If you have the vRealize Business license, select this option and type the licensekey in the text box.

What to do next

Select the installation type whether you want to install or upgrade.

Select the Installation TypeYou can select the vRealize Business installation types whether you want to perform a complete or custominstallation, upgrade, or create or upgrade only the database schema.

Prerequisites

Run the vRealize Business installer and select the installation mode.

Procedure

u Select one of the installation types and click Next.

n Complete. To install vRealize Business for the first time. This is the default mode.

n Upgrade. To upgrade your existing vRealize Business version.

n Custom. To install only the selected components.

n Database Schema. To create or upgrade your database schema.

What to do next

Select the database schema.

Chapter 2 Install vRealize Business

VMware, Inc. 17

Page 18: vRealize Business Installation and Administration Guide ... · Using or Linking Veritas NetBackup with vRealize Business 54 ... vRealize Business Installation and Administration Guide

Select the Database Schema configurationDuring vRealize Business installation, you must determine the configuration for the database schema.

Prerequisites

Run the vRealize Business installer and select the installation type.

Procedure

1 On the Database Schema page, create a new schema or upgrade an existing one.

n Do Not build Database Schema: The installer uses the existing database schema, without creatinga new schema or upgrading the existing schema.

NOTE The Do Not build Database Schema option requires a valid database schema that iscompatible with the vRealize Business version that is being installed.

n Create New Database Schema: The installer uses the scripts to create a new schema. For thisoption, you need the user name and password that have been created in the database. If youalready have a schema in this location, a warning appears at the end of the installationconfiguration. This option is selected, by default.

n Upgrade Database Schema: The installer uses upgrade scripts that are available with theinstallation files to upgrade the existing schema to the vRealize Business version that is beinginstalled.

2 Click Next.

What to do next

Select the source of the schema content.

Select a Source for the Database Schema ContentYou can select the source of the database schema content. you can use the scripts or a dump file.

Prerequisites

Run the vRealize Business installer and select the database schema.

Procedure

1 On the Database Schema Content Source page, select the source of the schema content.

n Default scripts: The installer uses scripts for the latest build included with the Installation wizard.This option is selected by default.

n Custom: The installer uses a dump file which is not included in the Installation wizard.

2 Click Next.

What to do next

Select the dump file or select the application server or Web server.

vRealize Business Installation and Administration Guide

18 VMware, Inc.

Page 19: vRealize Business Installation and Administration Guide ... · Using or Linking Veritas NetBackup with vRealize Business 54 ... vRealize Business Installation and Administration Guide

Select a Custom Dump FileYou can select a custom dump file as the source of the schema content.

Prerequisites

In the Installation wizard, select the option for using a custom dump file on the Database Schema ContentSource page.

Procedure

1 On the Custom Dump File page, click Select File to select the custom dump file.

The dump file path cannot contain spaces. The Oracle Client version must match the version of theserver. If you want to upgrade the dump file, complete the installation and rerun the installation wizardwith the Upgrade Schema option only.

2 Click Next.

What to do next

Select the application server or Web server.

Select Installation ProceduresYou can select or view a list of procedures that run during the installation.

Prerequisites

Run the vRealize Business installer and select the application or the web server.

Procedure

1 On the Installation Procedures page, review the list of procedures that the installer performs.

The options on the Installation Procedure page varies based on the installation type selected. All theoptions are selected by default.

n If you are installing vRealize Business for the first time on the computer, the Tomcat Installationand Tomcat Instance Configuration options appear.

n If you have selected Upgrade Database Schema on the Database Schema page or Custom on theDatabase Schema Content Source page, you can select or deselect the Redefine Applications toInstall and Modify vRealize Business System Type options.

2 Click Next.

What to do next

Define the server parameters.

Select Applications to InstallWhile installing vRealize Business, you can select applications to install such as Portfolio, SLA Manager, orIT Financial Manager. If you plan to use a custom dump file for the content source, the installation wizarddoes not display the Applications page.

Prerequisites

Select Default Scripts as the source for the database schema content .

Chapter 2 Install vRealize Business

VMware, Inc. 19

Page 20: vRealize Business Installation and Administration Guide ... · Using or Linking Veritas NetBackup with vRealize Business 54 ... vRealize Business Installation and Administration Guide

Procedure

1 On the Applications page, select the vRealize Business applications to install.

NOTE You can select the Portfolio option only if you select at least one application.

2 Click Next.

When you select the installation type as upgrade, custom or database schema, the application page andsystem type configuration pages are not applicable or available.

What to do next

Select a System Type.

Select a System TypeYou can install vRealize Business on several different system types, such as single or multiple customers,alliance, or shared services.

Prerequisites

You must select default scripts as the source for the database schema content.

Procedure

1 Select a system type.

System Type Description

Single Customer An instance of vRealize Business has exactly one customer.vRealize Business calculates cost and resource statistics for the customer.

Alliance An instance of vRealize Business has exactly one customer, but might beserviced by one or more providers. vRealize Business calculates statisticsfor the customer.

Multiple Customers A service provider running an instance of vRealize Business has multiplecustomers and might have one or more providers as well.vRealize Business calculates cost and resource statistics for the serviceprovider running vRealize Business.

Shared Services An instance of vRealize Business has multiple customers and providersrepresented by other divisions within the organization. vRealize Businesscalculates statistics for the organization running the instance ofvRealize Business.

You selection in vRealize Business determines whether to present data filtered by either customers orby providers.

2 If vRealize Business has only one agreement ,select Single Agreement.

3 If you want to include information about providers in vRealize Business and in its reports, selectManage Providers.

The providers option appears in the Organization menu in vRealize Business.

4 In the Approval Type drop-down menu, select the approval type - Customer Approval or ProviderApproval.

5 Click Next.

What to do next

Specify Server Parameters.

vRealize Business Installation and Administration Guide

20 VMware, Inc.

Page 21: vRealize Business Installation and Administration Guide ... · Using or Linking Veritas NetBackup with vRealize Business 54 ... vRealize Business Installation and Administration Guide

Provide Server Parameters for the Application ServerThe Tomcat application servers accept different parameters.

Only parameters that are applicable for your environment are available for selection.

Prerequisites

Run the vRealize Business installer and select the application server or Web server.

Procedure

1 Update the values on the Server Parameters page.

u Tomcat

NOTE For Installation, upgrade and redeployment or when you select Upgrade as the installationtype, only Server Instance is displayed on the Server Parameters page.

Option Action

Installation basedirectory

Click Select Folder to select the base directory where you want the embeddedvRealize Business Tomcat server to be installed.

Server Instance Type a unique name for this instance of vRealize Business.

Install HTTPConnector

Select this option to enable install vRealize Business over HTTP protocol.

HTTP Listen Port Type a valid port number.

Install HTTPS (SSL)Connector

Select this option to install and authenticate vRealize Business by using Secure SocketLayer (SSL) protocol.

SSL Listen Port Type the valid port number for secure requests

Shutdown Port Enter a port for vRealize Business to shut down, when it detects an activity on theport . The default port is 8006.

Java Home Click Select Folder to browse to the Java Home directory. vRealize Business Installerinstalls Java 1.7.0_72, by default.NOTE It is mandatory to provide your own JDK (1.7 and above) path for the Linux orUnix systems.

Install as WindowsService

Select this option to start Tomcat as a Windows Service when vRealize Business starts.

Service name Type a name for the service. If you do not specify a name, vRealize Business uses theserver instance name.

Installation FilePermissions

A new parameter is added to the Server Parameters of the Installer. This is used whileexecuting a recursive chmod command. The default value for this parameter is go-rwxand this restricts the permissions to other users.This means that only the user who has installed the product have the eligibility to runthe parameter using the default settings. The parameter is only applied to the Unixbased systems like Linux and Mac.

Install as ClusterNode

Select this option to install the server instance as a member of a cluster.NOTE If you are not using Tomcat, see the documentation for your application serverexternal software, or hardware to determine the cluster type.n Install as a Windows servicen Install as a cluster noden Install a cluster load balancerThe Tomcat cluster feature listens at ports 45564 and 4000 by default.For more information about installing vRealize Business in a cluster environment, see “About Installing vRealize Business in a cluster environment,” on page 14.

Chapter 2 Install vRealize Business

VMware, Inc. 21

Page 22: vRealize Business Installation and Administration Guide ... · Using or Linking Veritas NetBackup with vRealize Business 54 ... vRealize Business Installation and Administration Guide

2 Click Next.

If you have selected Tomcat, the HTTPS (SSL) parameters page opens.

What to do next

For Tomcat, specify SSL parameters.

Specify HTTPS (SSL) ParametersFor the Tomcat application server, you can provide key parameters by typing their values or selecting a fileto copy the values.

Prerequisites

Run the vRealize Business installer and select the Tomcat with SSL.

Procedure

1 Type a name for the server.

2 Type the company name.

3 Type an organization unit name .

4 Type the country code.

5 (Optional) Select the Use Existing key store option and click Select Folder to select the key store file tocopy.

What to do next

Specify your database parameters.

Configure Oracle Database ParametersvRealize Business uses Oracle as its database server. So, you must specify database parameters duringvRealize Business installation.

Prerequisites

Install Oracle client and create an Oracle user.

Also, you have installed Oracle client and created Oracle user.

Procedure

1 On the Database Parameters page, provide credentials for accessing the Oracle database.

vRealize Business Installation and Administration Guide

22 VMware, Inc.

Page 23: vRealize Business Installation and Administration Guide ... · Using or Linking Veritas NetBackup with vRealize Business 54 ... vRealize Business Installation and Administration Guide

2 Define the Oracle instance by using Custom Oracle Connect Descriptor.

n Provide the host, port, and instance name.

Option Action

Oracle Host The name of the system where Oracle is running.

Oracle Port The Oracle port number, the port where an Oracle service is listening. Bydefault, the value is set to 1521.

Oracle Database InstanceName (SID)

The Oracle instance name provided when you installed Oracle.

n Use an Oracle connect descriptor.

Option Action

Use Custom Oracle Connect Descriptor Select the check box.

Custom Oracle Connect Descriptor Enter the connect descriptor string.

NOTE You must use the Custom Oracle Connect Descriptor option only when a complex connectdescriptor is required.

3 Click Next.

What to do next

Define authentication types.

Define a User Authentication TypeDuring installation, you can define the authentication method by which users access vRealize Business. Themethod also determines where the user credentials are stored.

Prerequisites

Run the vRealize Business installer and specify database parameters.

NOTE When you select the installation type as upgrade, custom, or database schema, the UserAuthentication page is not available or applicable.

Procedure

1 Select the authentication type.

n RDBMS - The RDBMS authentication type uses vRealize Business database tables to verify andstore user credentials. The administrator creates users in vRealize Business, which stores usercredentials database tables.

n LDAP (including Active Directory) - The LDAP authentication type uses an LDAP repository toverify users. When users, whose credentials are stored in an LDAP repository, try to log in tovRealize Business, the vRealize Business sends a verification request to LDAP. If the users areconfirmed and have valid credentials, vRealize Business approves the login request.

n Single Sign-On - The Single Sign-On (SSO) method does not provide authentication. SSO users login to the vRealize Business from a secure environment, for example, a company portal.

Chapter 2 Install vRealize Business

VMware, Inc. 23

Page 24: vRealize Business Installation and Administration Guide ... · Using or Linking Veritas NetBackup with vRealize Business 54 ... vRealize Business Installation and Administration Guide

2 To copy all existing and new users from the Lightweight Directory Access Protocol (LDAP) repositoryto vRealize Business, select Enable user synchronization.

If you do not enable user synchronization, You must create LDAP users in the vRealize Business withthe same user name as in the LDAP repository.

n Use this option if you have a small number of LDAP users. You do not need to create the users invRealize Business manually.

n Do not use this option if you do not want to grant permission for all of your LDAP users to accessvRealize Business, or if you have a limited number of vRealize Business licenses.

NOTE If you have selected RDBMS, this option is disabled for selection.

3 (Optional) If you are synchronizing your users, create local users outside the LDAP repository byselecting Enable local users.

By default, when you use an LDAP repository, you cannot add local users to your vRealize Businesssystem. This option can be useful to create a test user.

4 Click Next.

n If you have selected LDAP, provide the required information on the LDAP Connection page.

n If you have select SSO, provide additional SSO configuration details:

a On the SSO Configuration page, select an SSO type.

b If you are using the HTTP header parameter method, type a user ID parameter name.

c In the Logout Redirect Page text box, type the URL where your vRealize Business installationdirects users when they log out.

d Click Next.

e If you are using NTLM, provide the required information on the NTLM SSO Parameters page andclick Next.

What to do next

Create or add users.

Define a Lightweight Directory Access Protocol ConnectionYou need to define the Lightweight Directory Access Protocol (LDAP) connection, if you select the userauthentication type as LDAP during installation.

Prerequisites

Run the vRealize Business installer and specify the user authentication type as LDAP.

Procedure

1 On the LDAP connection page, select the LDAP type.

2 Define the LDAP server and LDAP port details.

3 Select the option to install and authenticate vRealize Business by using Secure Socket Layer (SSL)protocol.

NOTE When you install the SSL certificate, you need to enter the Keystore Password.

4 Define the LDAP user and LDAP password.

5 Provide the base domain name and LDAP attribute to authenticate users.

vRealize Business Installation and Administration Guide

24 VMware, Inc.

Page 25: vRealize Business Installation and Administration Guide ... · Using or Linking Veritas NetBackup with vRealize Business 54 ... vRealize Business Installation and Administration Guide

What to do next

Specify the LDAP synchronizations details.

LDAP Synchronization for Users or GroupsDuring installation, you can synchronize the users or groups or else the users are copied from the LDAPrepository.

Prerequisites

Run the vRealize Business installer and specify the LDAP connection.

Procedure

1 On the LDAP synchronization page, enter the LDAP user or object class.

2 Define the LDAP query for synchronizing users or groups.

NOTE Select the checkbox to enable the group synchronization, inorder to define the LDAP query forsynchronizing the groups.

3 You can define the users or groups at a later point by selecting the checkbox to allow empty user orgroup query results.

4 Click Next.

What to do next

Specify system administrator user details.

Create an User for Logging in to vRealize BusinessYou must create a user to log in to vRealize Business. The user created during the vRealize Businessinstallation is given administrative privileges.

Prerequisites

Run the vRealize Business installer and the select the user authentication type.

Procedure

1 On the Administrator User page, provide a user name for the vRealize Business administrator.

2 Type and confirm a password.

The password must be of 6 to 32 characters with valid character set (a-z, A-Z,0-9, _, #, $).

3 Click Next.

NOTE When you select the installation type as upgrade, custom, or database schema, the AdministratorUser page is not available or applicable.

What to do next

Provide application location to install.

Chapter 2 Install vRealize Business

VMware, Inc. 25

Page 26: vRealize Business Installation and Administration Guide ... · Using or Linking Veritas NetBackup with vRealize Business 54 ... vRealize Business Installation and Administration Guide

Select an Application File for vRealize Business installationYou must provide the location of the application file (.war file) to install vRealize Business.

Prerequisites

Run the vRealize Business installer and create an vRealize Business administrator user.

Procedure

u On the Application Location page, select the location of the .war file and click Next.

Option Description

Default (File bundles with installer) Select a location of the .war within the installer file.

Custom (File from disk) Select a file from different location on the system.

What to do next

Based on your selection (default or custom), select the content packages or browse to select the .war file.

Content Packages in vRealize BusinessContent packages contain additional objects such as reports, adaptors, and role definitions, which are notincluded in vRealize Business, by default.

Table 2‑1. Available Content Packages

Package Description

Standard Roles Includes a predefined, standard set of roles and actions that eliminate the need to create roles invRealize Business. You can view these roles in the Administration module.

Common Contains basic objects that vRealize Business requires, but do not specifically belong in other contentpackages.

Data ValidationReports

Includes a group of special adaptors and reports that display summaries and details of datavalidation problems. These objects are located in the vRealize Business Designer Workshop under theData Validation folder.

AuditingReports

Provides a basic set of auditing reports and adaptors. These objects are located in thevRealize Business Designer Workshop under the Audit folder.

SLA Manager Contains adaptors, flows, BRTs, and reports. It supplies the SLM menu in vRealize Business withcompliance, credit, and bonus reports by using tiered calculations by using DFL_BREACHES. Theseobjects are located in the vRealize Business Designer Workshop under the SLM folder.

Portfolio Imports the initialization and population batch, which includes several procedures that create thepackage tables and populates them by extracting data from the audit tables. The batch is scheduled torun every 30 minutes. When this package is installed, all of the content reports are filled with datawithin 30 minutes. These objects are located in the vRealize Business Designer Workshop and ReportManagement under the Service Portfolio Management folder.

IT FinancialManager

Contains all of the content for the IT Financial Management application, including adaptors, flows,reports, and dashboards. These objects are located in the vRealize Business Designer Workshopunder the ITFM Content folder.

Custom Package Includes a custom content package during vRealize Business installation.

Additional SQLscript

Runs additional SQL scripts. These scripts run at the end of the vRealize Business installation process.

vRealize Business Installation and Administration Guide

26 VMware, Inc.

Page 27: vRealize Business Installation and Administration Guide ... · Using or Linking Veritas NetBackup with vRealize Business 54 ... vRealize Business Installation and Administration Guide

Select Content PackagesDuring installation, you can import the content packages that provide additional objects, such as reports,adaptors, and role definitions that are not included in the vRealize Business.

Prerequisites

Run the vRealize Business installer and select the application file location.

Procedure

1 On the Content Packages page, select the content packages that you want to import.

Several content packages are mandatory and are selected by default during the complete installation.

2 (Optional) Import a predefined or custom content package.

a Select the Custom Package check box.

b Click Select File to browse to the file.

c In the Select File dialog box, navigate to the file and click Select File.

3 Click Next.

Configure Advanced SettingsYou can customize your installation by defining several, more complex, advanced settings options. If you donot define these options during installation, you can define them later.

Prerequisites

Run the vRealize Business installer and select the content packages.

Procedure

1 Select a SQL script file that runs after installation.

a Click Select File to browse to the file.

b In the Select File dialog box, navigate to the file and click Select File.

After installation, you can run SQL scripts against database tables as required. You can use a file, forexample, to correct inconsistent formatting in the database before using the data in vRealize Business.

2 Select the Install as Frontend Instance check box to install vRealize Business as a frontend instance in acluster environment.

For security reasons, consider dedicating two servers.

n One server runs all of the backend processes, including the vRealize Business engine, whichcollects data from adaptors.

n The other server, which points to the same database, works as the frontend server. No backendprocesses run on this server. Because this server references the same database, reports and othervRealize Business objects are updated with the appropriate information. However, the processingand data collection occur on the backend instance server.

NOTE This option is available only for cluster installation. A cluster configuration with frontendinstances guarantees that only one server in the cluster handles the backend processes such as the maildistributor and data purging. To define a system as a frontend instance after installation, set theIS_SCHEDULER property in DFConfig/serviceflow.properties to 0.

Chapter 2 Install vRealize Business

VMware, Inc. 27

Page 28: vRealize Business Installation and Administration Guide ... · Using or Linking Veritas NetBackup with vRealize Business 54 ... vRealize Business Installation and Administration Guide

3 To define an alternative URL for your vRealize Business server, type the server URL in the Server URLtext box.

By default, the server URL uses localhost. You can type an IP address for the server URL. If you have aUNIX machine with multiple network cards, you must provide the IP address.

4 If your users access vRealize Business from an external proxy server, type the URL in the ExternalServer URL text box for security purposes.

NOTE After installation, you can assign a URL to the EXTERNAL_SERVER_URL property inDFConfig/serviceflow.properties as required.

5 In a cluster environment, secure your database coonnections.

a From the first system that was installed in the cluster, copy the key from the DF-Config/ITBM.keyfile.

b Paste the key in the Encryption Key for Data Sources text box.

NOTE For systems that must share the encryption key, such as servers in a cluster installation, copy andpaste the key in the text box while installing each instance.

6 Select an alternative location for the flat_file.properties file.

a Click Select File to browse to the file.

b In the Select File dialog box, navigate to the file and click Select File.

By default, these locations are listed in the DF-Config/flat_file.properties file.

NOTE For security purposes, the vRealize Business allows access to only specific locations from whichflat file adaptors can upload data.

7 Select an alternative location for the dos_command_whitelist.properties file.

a Click Select File to browse to the file.

b In the Select File dialog box, navigate to the file and click Select File.

By default, these locations are listed in the DF-Config/dos_command_whitelist.properties file.

NOTE For security purposes, the vRealize Business allows access a specific list of commands thatengine batches can run.

What to do next

To configure a mail distributor.

Configure a Mail DistributorTo configure a mail distributor service by setting the user name and password.

Procedure

1 Select the Configure Mail Distributor check box.

2 Enter the SMTP Server and Sender details.

NOTE It is mandatory to provide the SMTP server and sender details.

3 Enter the User Name and Password to configure the mail.

vRealize Business Installation and Administration Guide

28 VMware, Inc.

Page 29: vRealize Business Installation and Administration Guide ... · Using or Linking Veritas NetBackup with vRealize Business 54 ... vRealize Business Installation and Administration Guide

What to do next

Review your installation settings and complete the installation procedure.

Complete the Installation ProcedureYou can review your vRealize Business installation settings and complete the installation.

Prerequisites

Run the vRealize Business installer and select the required configurations.

Procedure

1 On the Start Server page, select whether you want the server to start after installation, and click Next.

NOTE In certain cases, for example if you are installing vRealize Business as a Windows service, youmight not want to automatically start the server.

2 On the Installation Checks page, select whether you want to delete temporary files that the installprocess generates. If you want to keep the temporary files to review the installation log, you can deletethese files manually after the installation finishes.

3 Click Next.

The installer starts verifying all the configurations that you specified. The verification process mighttake several minutes.

4 Review the information in the Installation Summary page and click OK.

5 On the Installation Progress page, click Install to proceed with the vRealize Business installation. Youcan make changes by navigating back or see installation details. The output statements and errorsappear in the appropriate tabs.

6 When the installation process is completed, click OK and click Exit.

What to do next

Log in to vRealize Business and perform the required tasks.

vRealize Business Advanced or Enterprise with vRealize BusinessStandard Integration Activation Procedure

The vRealize Business administrator can enable the integration betweenvRealize Business Advanced and Enterprise and vRealize Business Standard.

To install the vRealize Business certificate on the vRealize Business server machine

Prerequisites

You can download the certificate that you can import into vRealize Business Advanced and Enterprise. Foradditional information on token, see vRealize Business Standard Installation and Administration Guide.

Chapter 2 Install vRealize Business

VMware, Inc. 29

Page 30: vRealize Business Installation and Administration Guide ... · Using or Linking Veritas NetBackup with vRealize Business 54 ... vRealize Business Installation and Administration Guide

Procedure

1 Open the command line terminal and navigate to your vRealize Business server instance folder and runthe following command:

keytool -import -alias <alias> -file <path to the certificate file saved from previous step>

keystore <Your Application Server JRE path>\lib\security\cacerts

NOTE By default the vRealize Business server JRE is installed through the vRealize Businessinstallation and can be found at <Your vRealize Business Installation Path>\Tomcat-<Tomcatversion>\Java\jdk\jre.

2 When prompted for a password type the Java keystore password. By default it is change it.

3 Restart the vRealize Business server.

What to do next

To update the vRealize Business Standard URL connection, see “Update vRealize Business StandardConnection Details in vRealize Business,” on page 30

Update vRealize Business Standard Connection Details in vRealize BusinessTo edit or update the vRealize Business Standard connection details in vRealize Business.

Prerequisites

You need to generate the token from vRealize Business Standard. For additional information on token, seevRealize Business Standard Installation and Administration Guide.

Procedure

1 Browse to open the vRealize Business designer.

2 Click Input > URL Connections.

3 Click Add.

In the new URL connection window, add name, update url as https://<vRealize Business StandardServer>:443/ITBMS-external-api/ as seen in token generation dialog.

NOTE The url is provided when generating the token from vRealize Business Standard.

4 Select the authentication method to vRealize Business Standard authentication and add the token fieldvalue from the token generation dialog and click Add.

What to do next

To upload the mapping files, see “Upload Mapping Files to vRealize Business,” on page 30.

Upload Mapping Files to vRealize BusinessIn order to co-relate between vRealize Business Standard and vRealize Business Advanced and Enterpriseyou need to provide several mapping files.

Procedure

1 Click Costing > Upload Data Sources.

2 Upload a mapping file, for each of the four mapping file adaptors:

n VMware ITBM Standard Consumer Mapping

n VMware ITBM Standard Project Mapping

vRealize Business Installation and Administration Guide

30 VMware, Inc.

Page 31: vRealize Business Installation and Administration Guide ... · Using or Linking Veritas NetBackup with vRealize Business 54 ... vRealize Business Installation and Administration Guide

n VMware ITBM Standard Public Cloud Account Mapping

n VMware ITBM Standard Public Cloud Offering Mapping

3 Click Save.

Manage the Budget in vRealize Business Advanced or Enterprise withvRealize Business Standard

To export the information from the report that should be used in vRealize Business Advanced or Enterpriseand to create users with specifc permissions.

Prerequisites

Verify that you are connected to vRealize Business Standard.

Procedure

1 In vRealize Business Standard, select Administration > Business Management and expandvRealize Business section.

2 Click to download all report links and export the zip file.

3 Extract the zip file to adaptor_file folder in the vRealize Business Advanced or Enterprise instance.

4 In vRealize Business designer, select Tools > Batch Editor, select Showback Management and clickFlow Manager.

5 Click Run to fetch data for clusters, services and others.

6 Create or modify two users and to add users, see the topics related to Add a User in the vRealize BusinessUser Guide.

7 Set the roles for the two users:

n Director of Cloud with domain set to All Business Entities

n Business Group Manager with domain set to Business Group

NOTE Time zone of vRealize Business Standard should be before the time zone of vRealize BusinessAdvanced or Enterprise inorder for the batch to fetch the data.

Modify the Out-of-the-Box Cost ModelIf you do not have vRealize Business Standard and is interested in using the same flow, to upload the datayou can use the Out-of-the-Box (OOTB) cost model.

The primary cost model has a few changes to adapt for the vRealize Business Standard integration.

n The virtual servers cost object is replaced with the private cloud cost group and its child cost objects(RAM, CPU and storage) representing the components of the private cloud infrastructure.

n Allocation rules to private cloud are such that any cost coming into the group is split between CPU andRAM unless the cost originates from the storage or backup cost group which is routed to the storagecost object under private cloud.

n A new cost group called public cloud that is based on a dimension of the same name. The dimensionhas two hierarchy levels representing a public cloud vendor and the services or offerings acquired fromthe vendor and a new expense object is dedicated to public cloud expenses.

Chapter 2 Install vRealize Business

VMware, Inc. 31

Page 32: vRealize Business Installation and Administration Guide ... · Using or Linking Veritas NetBackup with vRealize Business 54 ... vRealize Business Installation and Administration Guide

vRealize Business Installation and Administration Guide

32 VMware, Inc.

Page 33: vRealize Business Installation and Administration Guide ... · Using or Linking Veritas NetBackup with vRealize Business 54 ... vRealize Business Installation and Administration Guide

Upgrading and Custom Installations 3You can upgrade vRealize Business using the installer. You can either upgrade an installation or canperform select installation procedures by using custom installations.

NOTE To upgrade from a version earlier than ServiceFlow 6.3.72 to the current version of vRealize Business,upgrade your system to ServiceFlow 6.3.74 and then run the installer for vRealize Business.

This chapter includes the following topics:

n “Upgrade vRealize Business Application and Database,” on page 33

n “Upgrade the vRealize Business Application,” on page 35

n “Upgrade the Database,” on page 36

n “Custom Installation,” on page 37

n “Update the Java Runtime Environment Version,” on page 38

Upgrade vRealize Business Application and DatabaseYou upgrade the application and database only when a new .war file is deployed into the system. Thewizard recognizes that an installation already exists and prompts you for only the necessary information toupgrade the system.

Prerequisites

n Remove any trailing backslash characters when setting the Server Instance. This is known to createinstallation difficulties during upgrades.

n From version 7.5 or later versions, shared dashboards are no longer supported. Any dashboards thatexist in the My Reports hierarchy under the incoming shared reports folder will be deleted. To preserveshared dashboards, you must move them into the My Reports hierarchy by using either the Move menuoption or the Save As menu option. Before the upgrade, check whether this feature is used, and if yes,verify with the users whether they want to preserve any shared dashboards or not.

n From Version 7.5 onwards, Out-of-the-Box roles are overwritten during an upgrade. If changes aremade to any of these roles, the administrator must update these roles manually after the upgrade. Ingeneral, if many changes are required to the Out-of-the-Box roles, create a copy of each role andmaintain all modifications in the copied roles instead of the Out-of-the-Box roles.

VMware, Inc. 33

Page 34: vRealize Business Installation and Administration Guide ... · Using or Linking Veritas NetBackup with vRealize Business 54 ... vRealize Business Installation and Administration Guide

Procedure

1 Run the vRealize Business installer.

System Description

Windows Navigate to the vRealize Business installation files and double-click theITBM-Installer_<BuildNumber>.jar file.

Non-Windows Run the <JAVA_HOME>\bin\java -jar ITBM-Installer_<BuildNumber>.jar command.

The vRealize Business installation wizard opens.

2 Click Next to start the installation procedure.

3 Select an installation mode and click Next.

n Evaluation Mode: This is the default mode.

n Licensed Mode: If you have the vRealize Business license, select the option and enter the licensekey in the text box.

4 Select Upgrade as the installation type.

5 Click Next.

6 On the Database Schema page, create a new schema or upgrade an existing one.

Option Description

Upgrade Database Schema The installer uses upgrade scripts that are available with the installationfiles to upgrade the existing schema.a Click Next.b In the Database Schema Content Source window, select Default

scripts that is included in the Installation environment.

Create New Database Schema The installer uses scripts to create a new schema for upgrading the contentof an external database.a Click Next.b In the Database Schema Content Source window, select Custom in the

Installation environment.c Click Next.d In the Custom Dump File window, click Select File to select the

custom dump file.

7 Click Next to start the installation procedure.

8 Select an installation mode and click Next.

n Evaluation Mode: This is the default mode.

n Licensed Mode: If you have the vRealize Business license, select the option and enter the licensekey in the text box.

9 Select Upgrade as the installation type.

10 Click Next.

vRealize Business Installation and Administration Guide

34 VMware, Inc.

Page 35: vRealize Business Installation and Administration Guide ... · Using or Linking Veritas NetBackup with vRealize Business 54 ... vRealize Business Installation and Administration Guide

11 On the Database Schema page, create a new schema or upgrade an existing one.

Option Description

Upgrade Database Schema The installer uses upgrade scripts that are available with the installationfiles to upgrade the existing schema.a Click Next.b In the Database Schema Content Source window, select Default

scripts that is included in the Installation environment.

Create New Database Schema The installer uses scripts to create a new schema for upgrading the contentof an external database.a Click Next.b In the Database Schema Content Source window, select Custom in the

Installation environment.c Click Next.d In the Custom Dump File window, click Select File to select the

custom dump file.

Upgrade the vRealize Business ApplicationTo upgrade the vRealize Business system (.war file) only and import the data through the dump file.

Prerequisites

n Remove any trailing backslash characters when setting the Server Instance. This is known to createinstallation difficulties during upgrades.

n From version 7.5 or later versions, shared dashboards are no longer supported. Any dashboards thatexist in the My Reports hierarchy under the incoming shared reports folder will be deleted. To preserveshared dashboards, you must move them into the My Reports hierarchy by using either the Move menuoption or the Save As menu option. Before the upgrade, check whether this feature is used, and if yes,verify with the users whether they want to preserve any shared dashboards or not.

n From Version 7.5 onwards, Out-of-the-Box roles are overwritten during an upgrade. If changes aremade to any of these roles, the administrator must update these roles manually after the upgrade. Ingeneral, if many changes are required to the Out-of-the-Box roles, create a copy of each role andmaintain all modifications in the copied roles instead of the Out-of-the-Box roles.

Procedure

1 Run the vRealize Business installer.

System Description

Windows Navigate to the vRealize Business installation files and double-click theITBM-Installer_<BuildNumber>.jar file.

Non-Windows Run the <JAVA_HOME>\bin\java -jar ITBM-Installer_<BuildNumber>.jar command.

The vRealize Business installation wizard opens.

2 Click Next to start the installation procedure.

3 Select an installation mode and click Next.

n Evaluation Mode: This is the default mode.

n Licensed Mode: If you have the vRealize Business license, select the option and enter the licensekey in the text box.

4 Select Upgrade as the installation type.

5 Click Next.

Chapter 3 Upgrading and Custom Installations

VMware, Inc. 35

Page 36: vRealize Business Installation and Administration Guide ... · Using or Linking Veritas NetBackup with vRealize Business 54 ... vRealize Business Installation and Administration Guide

6 Select Do not build Data Schema as the Database Schema.

Example: Upgrading the Application OnlyYou have a development environment and a production environment that are both running the sameversion. If the development environment is upgraded to a later version of vRealize Business, modificationsare made to the data, which is exported to a dump file. The dump file will also be in the later version.Because you plan to use this data in the production environment, you upgrade only the application in theproduction environment, and import the data from the dump file.

Upgrade the DatabaseTo upgrade the vRealize Business database only and import the database data through the dump file.

Prerequisites

To check the location of the database if you are using the custom dump file.

Procedure

1 Run the vRealize Business installer.

System Description

Windows Navigate to the vRealize Business installation files and double-click theITBM-Installer_<BuildNumber>.jar file.

Non-Windows Run the <JAVA_HOME>\bin\java -jar ITBM-Installer_<BuildNumber>.jar command.

The vRealize Business installation wizard opens.

2 Click Next to start the installation procedure.

3 Select an installation mode and click Next.

n Evaluation Mode: This is the default mode.

n Licensed Mode: If you have the vRealize Business license, select the option and enter the licensekey in the text box.

4 Select Database Schema as the installation type.

5 Click Next.

6 Select Upgrade Database Schema as the Database Schema.

Example: Upgrading the Database OnlyYou are working in your current vRealize Business environment and VMware releases new content data.This only affects the database and not the application, therefore you run the installer with the option toupgrade only the database, and use the dump file to add the new database data to the environment.

What to do next

Complete the installation steps from “Select a Source for the Database Schema Content,” on page 18onwards.

NOTE The content packages and advanced settings screens are not available or applicable while upgradingthe database.

vRealize Business Installation and Administration Guide

36 VMware, Inc.

Page 37: vRealize Business Installation and Administration Guide ... · Using or Linking Veritas NetBackup with vRealize Business 54 ... vRealize Business Installation and Administration Guide

Custom InstallationUse the custom installation to change specific details in the installation. This installation option should beused with caution and only by experienced users.

When you need to install a hotfix, VMware provides a special version of the vRealize Business installer.Verify that you have the correct version of the installer and follow the instructions for “Upgrade vRealizeBusiness Application and Database,” on page 33.

Procedure

1 Run the vRealize Business installer.

System Description

Windows Navigate to the vRealize Business installation files and double-click theITBM-Installer_<BuildNumber>.jar file.

Non-Windows Run the <JAVA_HOME>\bin\java -jar ITBM-Installer_<BuildNumber>.jar command.

The vRealize Business installation wizard opens.

2 Click Next to start the installation procedure.

3 Select an installation mode and click Next.

n Evaluation Mode: This is the default mode.

n Licensed Mode: If you have the vRealize Business license, select the option and enter the licensekey in the text box.

4 Select Custom as the installation type.

5 Click Next.

6 Select Create new Database Schema or Upgrade Database Schema as the Database Schema.

NOTE The Do not build Database Schema option requires a valid database schema that is compatiblewith the vRealize Business version that is being installed. This option is for expert users only and notrecommended.

Example: Situations that Require Custom InstallationYou might require custom installations when connecting an application to a different database schema,changing the vRealize Business system type configuration, installing Tomcat Web server without makingother changes, or installing Tomcat as a Windows service.

What to do next

Complete the installation steps from “Select a Source for the Database Schema Content,” on page 18onwards.

Chapter 3 Upgrading and Custom Installations

VMware, Inc. 37

Page 38: vRealize Business Installation and Administration Guide ... · Using or Linking Veritas NetBackup with vRealize Business 54 ... vRealize Business Installation and Administration Guide

Update the Java Runtime Environment VersionYou can use the latest Java Runtime Environment (JRE), when supplied with win32 JRE (1.7.0_72) forWindows and Linux.

Procedure

1 For Linux - In the file ITBM/Tomcat-7.0.52/bin/setenv.sh point the JAVA_HOME to the new location.

For Windows - In the file ITBM/Tomcat-7.0.52/bin/setenv.bat point the JAVA_HOME to the newlocation.

NOTE This should be the parent folder of the Java bin folder.

2 Restart the server.

3 Verify the JRE version.

vRealize Business Installation and Administration Guide

38 VMware, Inc.

Page 39: vRealize Business Installation and Administration Guide ... · Using or Linking Veritas NetBackup with vRealize Business 54 ... vRealize Business Installation and Administration Guide

Configuration Files 4The configuration files are used to configure the files used in vRealize Business.

This chapter includes the following topics:

n “Working with Configuration Files in vRealize Business,” on page 39

n “ServiceFlow Properties,” on page 39

n “About Flat Files,” on page 39

n “Batch Procedure Whitelist Properties,” on page 40

n “vRealize Business Key,” on page 40

n “vRealize Business License,” on page 41

Working with Configuration Files in vRealize BusinessIf you are an advanced user of vRealize Business, such as an administrator, you can use theserviceflow.properties, flat_files.properties, batch_procedure_whitelist.properties, ITBM.key, andITBM.license files to improve the system performance.

ServiceFlow PropertiesvRealize Business administrators can use the serviceflow.properties file to configure the following systemparameters:

n “Infrastructure Configuration Parameters,” on page 75

n “Dimensions Configuration Parameters,” on page 77

n “Database-Related Configuration Parameters,” on page 77

n “Engine-Related Configuration Parameters,” on page 78

n “Security Configuration Parameters,” on page 80

About Flat FilesYou can find a list of all the folders accessible for flat files adaptor. For security reasons, access to otherdirectories on the server through vRealize Business is not allowed.

n Contains a list of folders accessible for flat files adaptor.

n Each folder is represented by a separate line.

n Rows beginning with # are considered comments and are ignored.

VMware, Inc. 39

Page 40: vRealize Business Installation and Administration Guide ... · Using or Linking Veritas NetBackup with vRealize Business 54 ... vRealize Business Installation and Administration Guide

n Empty lines are ignored.

n You can access them by using a path relative to the application instance directory or by using theabsolute path.

n Exists in the .war file under default-config .

n Contains a single reference to the default adaptor_files folder.

n If a copy is placed in DF-Config, it extends the internal list.

n After you edit the file, you must refresh your cache.

Batch Procedure Whitelist PropertiesThis file contains a list of stored procedures which Engine Batches are allowed to run . For security reasons,other procedures are disallowed.

This is a list of stored procedures which Engine Batches are allowed to run. All other procedures produce anexception if you try to run them. The format is, each stored procedure is on a separate line, no commas arenecessary. Rows beginning with # are considered comments and are ignored. Empty lines are ignored. Youmay add more procedures at the end. This file exists in the .war file under default-config. It contains a list ofthe default procedures. If a copy is placed in DF-Config, it will EXTEND the internal list. If you make achange to this file you must do Refresh Cache.

Batch Procedure Whitelist Properties

n SF_ANALYZE_ADAPTORS

n SF_ANALYZE_FLOW

n SF_ANALYZE_FLOWS

n SF_ANALYZE_INDEX

n SF_ANALYZE_OPERATOR

n SF_ANALYZE_TABLE

n SF_CALC_LAST_COMPLIANCE_DATE

n SF_COMPACT_FLOW

n SF_COMPACT_FLOWS

n SF_COMPACT_FLOWS

n SF_COMPACT_OPERATOR

n SF_COMPACT_TABLE

vRealize Business KeyThis is a randomly generated key that is used for password encryption in the vRealize Business application.

If you move the server to a different computer, you must copy this file to correctly decrypt passwordsstored in the database.

vRealize Business Installation and Administration Guide

40 VMware, Inc.

Page 41: vRealize Business Installation and Administration Guide ... · Using or Linking Veritas NetBackup with vRealize Business 54 ... vRealize Business Installation and Administration Guide

vRealize Business LicenseIs the vRealize Business application license key which is provided by the user on the license key installationpage or through Administration > Tools > General Preferences > Licensing page.

Example12345-ABCDE-67890-ABCDE -12345

Chapter 4 Configuration Files

VMware, Inc. 41

Page 42: vRealize Business Installation and Administration Guide ... · Using or Linking Veritas NetBackup with vRealize Business 54 ... vRealize Business Installation and Administration Guide

vRealize Business Installation and Administration Guide

42 VMware, Inc.

Page 43: vRealize Business Installation and Administration Guide ... · Using or Linking Veritas NetBackup with vRealize Business 54 ... vRealize Business Installation and Administration Guide

Post-Installation Procedure

VMware, Inc. 43

Page 44: vRealize Business Installation and Administration Guide ... · Using or Linking Veritas NetBackup with vRealize Business 54 ... vRealize Business Installation and Administration Guide

vRealize Business Installation and Administration Guide

44 VMware, Inc.

Page 45: vRealize Business Installation and Administration Guide ... · Using or Linking Veritas NetBackup with vRealize Business 54 ... vRealize Business Installation and Administration Guide

Post Installation Tasks 5To use and verify vRealize Business, you must perform certain configuration tasks after completing theinstallation.

This chapter includes the following topics:

n “Log In to vRealize Business,” on page 45

n “Verify Basic vRealize Business Features,” on page 46

n “Configure Email Settings,” on page 46

n “Set the Time Zone,” on page 47

n “Oracle Parameters Customized for vRealize Business,” on page 47

n “Encrypting Passwords,” on page 48

n “Enable Data Table Archiving,” on page 49

n “Sending Traps with SNMP,” on page 49

n “Enabling SSL for Tomcat,” on page 50

n “Test the SSL Configuration,” on page 51

n “Verifying Character Compatibility,” on page 51

n “Supporting Lotus Notes,” on page 52

n “Configure vRealize Business Cluster Installation,” on page 52

Log In to vRealize BusinessTo access the vRealize Business login with your vRealize Business user credentials. You can login to theapplication using a web browser.

Prerequisites

Install the vRealize Business on the server.

Procedure

1 In your web browser, type the address in the following format: http://host:port.

n host is the name of the machine on which vRealize Business is installed.

n port is the port on which vRealize Business is running.

NOTE To connect to the designer, type http://host:port/jserf/sfd.jsp

VMware, Inc. 45

Page 46: vRealize Business Installation and Administration Guide ... · Using or Linking Veritas NetBackup with vRealize Business 54 ... vRealize Business Installation and Administration Guide

2 Type the user name and password and click Login.

A System Information page summarizes the system information of vRealize Business.

What to do next

You can create a new administrative user, set appropriate permissions, and reconnect to thevRealize Business with the new user credentials.

Verify Basic vRealize Business FeaturesAfter you install vRealize Business, you must test the computing environment, regardless of the applicationserver type.

Prerequisites

Log in to vRealize Business, create a user, and save the user settings.

Procedure

1 Log in to vRealize Business with your credentials.

A System Information page summarizes the system information of vRealize Business.

2 From the IT Financial Management drop-down menu, select Administration.

The vRealize Business Administration page with Security, Reports, and Tools tabs appears.

3 To verify creating a user feature, click Users on the Security tab.

A table lists all the users created in the vRealize Business.

4 To verify a database connection, click Tools > INPUT > Database Connections.

5 To verify creating an adaptor, click Tools > Workshop > Add > Adaptor.

The adaptor's page appears.

6 To verify creating a flow, click Tools > Workshop > Add > Flow.

The selected flow's page appears.

You successfully verified all the features of vRealize Business.

Configure Email SettingsYou can use vRealize Business email option to send reports, send data for adjustment and approval andnotify users about security breaches during user credential validation.

Procedure

1 From vRealize Business Administration page, select Tools > System Definitions > Backend Processes> Mail Distributor.

Mail Distributor: Configure Settings page appears.

2 Type details of the SMTP server, the sender's email address, credentials for your system, and click OK.

If you change email settings later, you must stop and restart vRealize Business.

3 Click Start > Programs Administrative Tools > Internet Services Manager.

On the customer’s mail server, check whether the SMTP configuration is correct.

4 In the Access tab, under Relay restrictions, click Relay.

Set relay permissions on Exchange server to accept mail from the vRealize Business server.

vRealize Business Installation and Administration Guide

46 VMware, Inc.

Page 47: vRealize Business Installation and Administration Guide ... · Using or Linking Veritas NetBackup with vRealize Business 54 ... vRealize Business Installation and Administration Guide

5 Select the SMTP server and click Properties.

Verify that no special permissions are set to prevent the mails from being sent. If the SMTP server hasOnly the list below option selected, it allows only certain sender addresses to send emails.

Set the Time ZoneThe vRealize Business receives input from many systems with potentially different time zones. You mustconfigure the time zone for your system so that the time-based report data is consistent and meaningful.

After the installation is finished, update the time zone information for your JDK to the most updatedversion.

n To view the updated instructions, go to http://www.oracle.com/technetwork/java/javase/tzupdater-readme-136440.html.

n Download the time zone update tool from http://www.oracle.com/technetwork/java/javase/downloads/tzupdater-download-513681.html.

NOTE

For the most up-to-date time zone information for a Windows and Linux OS, you must stop any runninginstances of the JDK/JRE software to be operated before you run the TZUpdater tool on the installedJDK/JRE software image.

Procedure

1 From the vRealize Business Administration page, select Tools > System Definitions > GeneralPreferences > Options tab.

2 Set the time zone for your system using the Timezone drop-down menu.

Oracle Parameters Customized for vRealize BusinessIn vRealize Business, the DBA modifies the values of Oracle parameters used by the vRealize Businessinstallations. The DBA also ensures that the session and process parameters correlate to the number ofconcurrent users present in the system.

The vRealize Business does not require the Oracle Recycle Bin feature. Disable this feature if you want torun vRealize Business on a dedicated database.

NOTE The sizes for the parameters are for the 64-bit version of Oracle. If you want to use the 32-bit verisonof the parameters, you need to tune the memory parameters.

Table 5‑1. Oracle Parameters that Require Modifications for vRealize Business

Parameter Description Oracle Version 11g

DB_BLOCK_SIZE Specifies the size of database blocks. 8KB, 16KB for Unicode databases

DB_CACHE_SIZE Specifies the size of the DEFAULTbuffer pool for buffers of the primaryblock size .

Unset the parameter .

SHARED_POOL_SIZE Determines the size of SQL statementcache. This parameter is used toenable the reuse of statements.

Unset the parameter.

LOG_BUFFER Determines the number of buffers,each the size of the system page,located in SGA as a result of thechanged data written to the redo logfiles.

Unset the parameter.

Chapter 5 Post Installation Tasks

VMware, Inc. 47

Page 48: vRealize Business Installation and Administration Guide ... · Using or Linking Veritas NetBackup with vRealize Business 54 ... vRealize Business Installation and Administration Guide

Table 5‑1. Oracle Parameters that Require Modifications for vRealize Business (Continued)

Parameter Description Oracle Version 11g

OPTIMIZER_MODE Enables the Oracle Cost-BasedOptimizer when statistics areavailable.

ALL_ROWS

CURSOR_SHARING Determines the type of SQLstatements that can share the samecursors. Setting the value of thisparameter to Exact allows onlystatements with identical text to sharea cursor.

Only the value Exact is supportedand certified .

WORKAREA_SIZE_POLICY Determines whether Oracle shouldautomatically allocate in the PGA andSGA, or that these areas will beallocated manually .

AUTO

SESSION_CACHED_CURSORS Specifies the number of cursors tocache per session.

5

PROCESSES Specifies the maximum number ofprocesses .

200

SESSIONS Specifies the maximum number ofsessions.

255

JAVA_POOL_SIZE Unset the parameter.

DB_WRITER_ PROCESSES The number of background databasewriter processes to start

3

PGA_AGGREGATE_ TARGET Target size for the aggregate ProcessGlobal Area memory consumed bythe instance.

Unset the parameter.

SGA_TARGET Unset the parameter.

SGA_MAX_SIZE Unset the parameter.

MEMORY_TARGET 5GB

MEMORY_MAX_ TARGET Unset the parameter.

Encrypting PasswordsYou can encrypt the password when the vRealize Business stores the user and user passwords for RDBMSauthentication. The password encryption is applicable for systems which use Tomcat as the Web server.

Encrypt User PasswordsYou can encrypt user password for Tomcat systems when vRealize Business stores the user and userpasswords for RDBMS authentication.

Procedure

1 In the jserf.xml file, add the digest="SHA" to the current definition of DataSourceRealm after theroleNameCol="group_name" parameter.

<Realm className="org.apache.catalina.realm.DataSourceRealm" debug="99"

dataSourceName="jdbc.frontend_data_source" localDataSource="true"

userTable="dfl_user" userNameCol="user_name" userCredCol="user_password"

userRoleTable="dfl_user_group_mapping" roleNameCol="group_name"

digest="SHA"/>

vRealize Business Installation and Administration Guide

48 VMware, Inc.

Page 49: vRealize Business Installation and Administration Guide ... · Using or Linking Veritas NetBackup with vRealize Business 54 ... vRealize Business Installation and Administration Guide

2 For user passwords, add the ENCRYPT_PASSWORD=true flag definition to DFConfig/serviceflow.properties file.

Encrypting Tomcat and LDAP Configuration PasswordsYou can encrypt vRealize Business user passwords stored in Tomcat configuration files.

Tomcat and LDAP configuration password encryption is controlled by the ENCRYPT_TC_ENV flag. By default,it is set to true. You can override this default setting in DF-Config/serviceflow.properties.

Enable Data Table ArchivingvRealize Business can archive data tables in a second database schema called the Archiving Databaseschema.

Prerequisites

You have to create the RUN_DDL stored procedure on the archiving database schema. To enable archiving,the Oracle user must have write permissions to the Archiving Database schema.

Procedure

1 Create a new schema for archiving on the same database as the vRealize Business schema.

2 Use the following script to create RUN_DDL()stored procedure in the archiving schema .

prompt

prompt Creating procedure RUN_DDL

prompt ==========================

prompt

create or replace procedure run_ddl(in_tab_name in varchar2) AUTHID CURRENT_USER is PRAGMA

AUTONOMOUS_TRANSACTION;

begin

execute immediate in_tab_name;

end run_ddl;

3 In the configuration file, remove the comment symbol from the following resource:

Resource name="jdbc.sf_archive_data_source"

The configuration file on Tomcat systems is jserf.xml.

4 Modify the username, password, and URL tags for jdbc.sf_archive_data_source resource to matchthe values in the archiving schema.

5 Restart the server.

Sending Traps with SNMPThe vRealize Business uses SNMP traps to recognize significant events by way of an unsolicited SNMPmessage.

Procedure

1 From the sf_log4j.properties file, uncomment the lines that begin with log4j.appender.TRAP_LOG.

You can use SNMP traps to send breach alerts and keep the back-end process alive. Thedigitalfuel.mib file, located in thejserf.war\WEB-INF\classes\snmp folder.

2 Set log4j.appender.TRAP_LOG.ManagementHost to the IP address of the machine that hosts the trapwatcher.

Chapter 5 Post Installation Tasks

VMware, Inc. 49

Page 50: vRealize Business Installation and Administration Guide ... · Using or Linking Veritas NetBackup with vRealize Business 54 ... vRealize Business Installation and Administration Guide

3 Install a trap watcher, such as CSCare Trap Console.

Events appear in the trap watcher.

Enabling SSL for TomcatYou can configure SSL on your Tomcat application server to encrypt information.

Prerequisites

For information on uploading the SSL certificate, see http://tomcat.apache.org/tomcat-6.0-doc/ssl-howto.html#Installing_a_Certificate_from_a_Certificate_Authority.

n Verify that the system administrator, or similar user, has installed the SSL certificate and provided thepath to the key file and its password.

n If you are using a reverse proxy, set the EXTERNAL_SERVER_URL property in serviceflow.properties file.This property can be set during installation.

Procedure

1 Set the SERVER_URL property in the serviceflow.properties file.

a Open DF-Config/serviceflow.properties.

b Update the SERVER_URL property to SERVER_URL=https://host name:external port/jserf/.

n Use a fully-qualified domain name as the host name. The term localhost is not a valid host namewhen using SSL.

n If enabling SSL in a cluster environment, each node in the cluster should be able to access all othernodes by their host names.

2 Navigate to conf/server.xml and replace your current connection definition with the followingdefinition to allow SSL traffic on your vRealize Business instance.

An example follows the definition. If the keystoreFile is of type .pfx, add the keystoreType="PKCS12"parameter to the connector:

<Connector port="[EXTERNAL PORT]" minSpareThreads="5" maxSpareThreads="75"

enableLookups="true" disableUploadTimeout="true" acceptCount="100"

maxThreads="200" scheme="https" secure="true" SSLEnabled="true"

keystoreFile="[FULL PATH TO KEYSTORE FILE]" keystorePass="[PASSWORD]"

clientAuth="false" sslProtocol="TLS"/>

<Connector port="8443" minSpareThreads="5" maxSpareThreads="75"

enableLookups="true" disableUploadTimeout="true" acceptCount="100"

maxThreads="200" scheme="https" secure="true" SSLEnabled="true"

keystoreFile="/home/df/.keystore" keystorePass="nod#90$stox"

clientAuth="false" sslProtocol="TLS"/>

NOTE You can limit access to the management operations by enforcing host authentication andauthorization, in addition to the user authentication.

3 To deny hosts or allow only specific hosts, the system administrator should browse <Tomcatroot>/<Instance_Name>/conf/server.xml and uncomment the valve element.

To restrict access from only certain hosts, fill in the deny or allow attributes and uncomment thefollowing line (use the regular expressions to define ip addresses).

<Valve className="org.apache.catalina.valves.RemoteAddrValve" deny="" allow=""/>

vRealize Business Installation and Administration Guide

50 VMware, Inc.

Page 51: vRealize Business Installation and Administration Guide ... · Using or Linking Veritas NetBackup with vRealize Business 54 ... vRealize Business Installation and Administration Guide

4 If the SSL certificate is not trusted by the JVM, import the root certificate.

In a cluster environment, each node in the cluster must import the certificate.

What to do next

Test the SSL configuration. See “Test the SSL Configuration,” on page 51.

Test the SSL ConfigurationAfter you configure your SSL system, you must verify that the configuration is correct.

Prerequisites

Enable SSL on your Tomcat system. See “Enabling SSL for Tomcat,” on page 50.

Procedure

1 Log in to the vRealize Business designer.

2 Select a table report that contains data.

3 From the Tools drop-down menu, select Export to Word.

Verifying Character CompatibilityOperating systems must have language definitions that correspond to the language used invRealize Business. Problems with character display might occur when you generate RTF files for export toMicrosoft Word or Excel.

Prerequisites

Verify that the language definition in the operating system is correct . If you cannot change the languagedefinition, use the following workaround. This is more common on UNIX systems.

Procedure

1 Open the appropriate file for your application server.

Table 5‑2. Application Server Details

Application Server File

Tomcat n Windows: ITBM\Tomcat 6.0.35\bin\catalina.batn UNIX and Linux: ITBM-Tomcat\Tomcat6.0\bin\catalina.sh

2 Append -Dfile.encoding=<encoding> to the string that begins with -Djcifs.properties=.-Djcifs.properties=.\DF-Config\serviceflow.properties -Dfile.encoding=<encoding>.

Chapter 5 Post Installation Tasks

VMware, Inc. 51

Page 52: vRealize Business Installation and Administration Guide ... · Using or Linking Veritas NetBackup with vRealize Business 54 ... vRealize Business Installation and Administration Guide

Supporting Lotus NotesWhen you send email reports that contain images to Lotus Notes users, the default image type invRealize Business (.png) cannot be viewed. The quality of the image differs with each image type.Additionally, the size of the email is significantly affected by the image type value.

Procedure

1 To set the type of images that are sent to Lotus Notes users, change CHART_IMAGE_TYPE_FOR_MAIL flag inDFL_OPTIONS to something other than the default, .png.

Table 5‑3. Image types supported in vRealize Business

Image Type Value

.gif 3

.png 4

.jpeg 7 (recommended)

.bmp 8

2 Refresh the cache in the vRealize Business user interface.

3 In the vRealize Business Oracle database, using SQL * Plus run the SQL truncate table command totruncate the RPS_CACHE table.

Configure vRealize Business Cluster InstallationSeveral additional modifications have to be done to use vRealize Business in a cluster environment.

For more information about vRealize Business cluster installation, see “About Installing vRealize Business ina cluster environment,” on page 14.

Prerequisites

Install vRealize Business on a shared systems, such as a cluster configuration.

Procedure

1 Configure session replication by updating the following properties.

n McastService - This is a multicast address that must be unique for each cluster. By default, thevalue is set to 228.0.0.4. This is used for heartbeat node discovery.

n NioReceiver - This is the listening port and address of the node.

For more information, see http://tomcat.apache.org/tomcat-7.0-doc/cluster-howto.html.

2 Configure backend scheduling by updating the DF-Config/quartz.properties file. Set theorg.quartz.jobStore.isClustered to True for cluster nodes to grab jobs and run at their owndiscretion.

You can disable quartz running backend services on a machine by setting the IS_SCHEDULER to 0 (Zero)in the DF-Config/serviceflow.properties file. Such machines are typically called frontend servers,because they do not run backend services.

3 Configure cache management by using Open Symphony library for distributed caching solution.Distributed caching allows the application to use cache for better performance and also synchronizes allnodes and cached data. Set the SERVER_URL property in the DF-Config/serviceflow.properties file in allnodes to a URL that other cluster nodes can use to access the machine (IP address).

vRealize Business Installation and Administration Guide

52 VMware, Inc.

Page 53: vRealize Business Installation and Administration Guide ... · Using or Linking Veritas NetBackup with vRealize Business 54 ... vRealize Business Installation and Administration Guide

Backup and Recovery 6Backups are critically important in the maintenance of your vRealize Business database server. Backups helpprevent data loss in the event of disk failures, software problems, or operator error.

NOTE Failure to back up your system can cause hours or days of unnecessary labor in the reproduction oflost files and configurations . The ideal backup strategy is to automate the backup process and minimize themanual actions performed by the system administrator.

This chapter includes the following topics:

n “Backup Strategies,” on page 53

n “Oracle Database Backups,” on page 54

n “Using or Linking Veritas NetBackup with vRealize Business,” on page 54

n “Recovery,” on page 54

Backup StrategiesYou need to take regular backups of file system and Oracle database. vRealize Business applicationsrecommends its users to follow these Backup strategies:

n In addition to the manual backups that you perform as part of system upgrades or planned hardwareand software maintenance, schedule regular file system and Oracle database backups.

n Back up your data to a secondary device, another server, tapes, or any other type of storage.

n Automate the backup process to maintain consistency.

n Back up your system during the night, when system usage is very low.

n Perform a full file system backup followed by incremental backups that back up changed files. Thispractice helps to do a quick system restore.

n Track backups and retain the media to ensure that you can recover from data loss.

Oracle database backups must be coordinated with the file system backups. This practice ensures that thesaved database files are not being modified while they are being copied, and old database files that are nolonger required on the disk can be removed after a successful backup image is made. If the old data is notremoved, the disk can fill up quickly.

VMware, Inc. 53

Page 54: vRealize Business Installation and Administration Guide ... · Using or Linking Veritas NetBackup with vRealize Business 54 ... vRealize Business Installation and Administration Guide

Oracle Database BackupsThe Oracle database contains most of the information that is used throughout the vRealize Business. Toensure that you can restore the database, perform a proper back up regularly.

Database Backup TypesThe following Oracle database backups provide alternative methods of recovery.

n Full Database Backups - Full database backups are used to restore the Oracle database to any specifictime, including the last time the database was operating normally. To use a full database backup forrecovery, operate Oracle in archive mode so the archive logs are copied to a save area. To recover to aspecific time, the last full backup files are loaded, then the archive log files are applied until the specifictime is reached. If archive log files are not available, a cold full database backup can still be used torestore the database to the point when the cold full database backup was made, but changes made afterthat time cannot be recovered. Recovery using a hot full database backup cannot be accomplishedunless all archive logs are available.

n Logical Oracle Database Backups - Logical Oracle database backups are used to recover to the timewhen the logical database backup was completed. The Oracle import tool is used to regenerate thedatabase in case of major failures. This type of recovery is useful to restore the database to a past statewhere the database is known to be undamaged. If the database has been damaged in some manner sothat it does not start up, then imports are not possible. In this case, the database must be rebuilt using acomplex process available in the Oracle installer, or the database can be restored from the most currentset of files produced by a cold backup.

The database backups must be integrated with the file system backups. The Oracle files are then ready to becopied to tape along with other disk files, and disk space is freed when old files are deleted after thesuccessful file system backup. Your system administrator should ensure that the folder containing thearchive logs, and the Oracle backup files are included in the file system backup.

Using or Linking Veritas NetBackup with vRealize BusinessWhen you use the Veritas NetBackup product with vRealize Business, there is some confusion as to whichdatasets comprise the vRealize Business solution.

You do not need to back up the binaries on a regular basis. Back up the Oracle database schema on a regularbasis by using an Oracle agent or library for Veritas. vRealize Business has no special requirements. TheVeritas NetBackup RMAN Oracle library must be linked to the Oracle binary file. This linking does notaffect the vRealize Business database schema.

RecoveryYou can use a backup of your data files, control files, archive log files, and initialization parameters torecover a failed database. You might want to create a copy of the vRealize Business application on anothersystem to aid in recovery.

You can use the following recovery options for media failure.

n Recover database

n Recover datafile

n Recover tablespace

vRealize Business Installation and Administration Guide

54 VMware, Inc.

Page 55: vRealize Business Installation and Administration Guide ... · Using or Linking Veritas NetBackup with vRealize Business 54 ... vRealize Business Installation and Administration Guide

Perform a Generic RecoveryYou can perform a generic recovery to restore a failed database.

Prerequisites

From the failed database, take a back up of your data files, control files, archive log files, and initializationparameters.

Procedure

1 Shut down the database or the affected datafile or tablespace and take it offline.

2 Restore the datafile from a backup along with the archived redo logs created since the backup.

3 Run a Recover command.

The datafiles are brought back online.

Chapter 6 Backup and Recovery

VMware, Inc. 55

Page 56: vRealize Business Installation and Administration Guide ... · Using or Linking Veritas NetBackup with vRealize Business 54 ... vRealize Business Installation and Administration Guide

vRealize Business Installation and Administration Guide

56 VMware, Inc.

Page 57: vRealize Business Installation and Administration Guide ... · Using or Linking Veritas NetBackup with vRealize Business 54 ... vRealize Business Installation and Administration Guide

Planning Requirements forvRealize Business 7

As a user, you can use various techniques to estimate the disk space requirements of the vRealize Businessapplication. With this option you can plan the future business needs of vRealize Business.

This chapter includes the following topics:

n “Factors Affecting the Disk Capacity Calculation,” on page 57

n “Configuring the Database Disk,” on page 58

n “RAID Devices,” on page 59

Factors Affecting the Disk Capacity CalculationVarious factors affect the disk capacity calculation of vRealize Business. You can identify the factors andtake necessary action to enhance the performance of the vRealize Business application.

The following factors affect the capacity calculation of vRealize Business:

n Number of operators in a flow

n Number of business rules defined for a flow

n Number of rows in an adaptor

n Complexity of the lines in an adaptor (number of bytes per line)

n Operator-specific factors such as configuration and additional attributes.

Flow Size CalculationYou can use this to calculate the amount of disk space required for storing the instance of vRealize Business.

You can use this formula to determine the amount of disk space that stores an vRealize Business instanceand all the other calculations associated with the vRealize Business application.

(Number of lines in Adaptor) * (Number of bytes per line) *

(Number of operators in the Flow) * (Number of BRs in the Flow) * (2)

The following operators affect the number operators in the flow calculation.

VMware, Inc. 57

Page 58: vRealize Business Installation and Administration Guide ... · Using or Linking Veritas NetBackup with vRealize Business 54 ... vRealize Business Installation and Administration Guide

Table 7‑1. Operators Affected by Flow Size Calculation

Operator Description

Aggregate Aggregate functions in the flow’s aggregate operators directly contribute to theNumber Operators in the Flow value . If the flow contains one or moreaggregate operators, count the number of aggregate functions in each aggregateoperator. Add this number of functions to the number of other, non-aggregateoperators. This total is the Number Operators in the Flow value.For example, say a flow has five operators and three of them are aggregate. Eachaggregate operator has two aggregate functions, so the flow has six aggregatefunctions. The Number Operators in the Flow value in this case is eight, six foraggregate and two for the other two operators.

Identify If the flow contains the Identify operator, use this formula to determine the numberto substitute for the identify operator:(Number of lines in Adaptor) * (Highest mapping ratio)

The mapping ratio value is the number of business units or groups to which aparticular resource is mapped. If this ratio cannot be determined, use this formula todetermine the Identify operator:(Number of Providers) * (Number of Customers) * (Number of Groups)

Configuring the Database DiskTo improve vRealize Business application performance you must select the appropriate file distribution anddatabase disk configuration values.

vRealize Business Data Storage TablespacesvRealize Business data is stored in data files on the disk, which are grouped together into logical storageunits called tablespaces. The Oracle database contains all the default tablespaces.

The following table describes some of the data storage terms associated with the vRealize Businessapplication.

Table 7‑2. Data Storage Terms Used in vRealize Business

Data Storage Term Description

System Used for data dictionary objects such as tables, indexes,utilities, and packages. No objects must reside in thistablespace except for the Oracle metadata.

Undo Used for storing the undo data of committed transactionsto enable the rollback of transactions.

Temp (or Temporary) Used for holding temporary segments created by sortoperations written to a disk. To improve performance, thistablespace is usually of a temporary type. No permanentobjects can reside in this tablespace, and it must not resideon a RAID disk. Place the temporary tablespace data fileson fast devices, which do not need to be large storagedevices.

Application tablespace One or more tablespaces used for storing tables andindexes.

NOTE You must ensure that vRealize Business data and indexes are stored as separate entries.

vRealize Business Installation and Administration Guide

58 VMware, Inc.

Page 59: vRealize Business Installation and Administration Guide ... · Using or Linking Veritas NetBackup with vRealize Business 54 ... vRealize Business Installation and Administration Guide

vRealize Business Storage Workload AnalysisUsing the various logs and database control files you can understand the workload on the different storagedevices used in vRealize Business. For example, the redo logs are considered hot I/O locations, because theyconsist of two or more preallocated files that store all changes made to the database as they occur. For thisreason the redo logs are placed on a separate, exclusive, fast storage device. This practice prevents themfrom becoming the database bottleneck.

The following table describes the definition of some of the database file disk distribution terms associatedwith the vRealize Business application.

Table 7‑3. Database File Disk Distribution Terms Used in vRealize Business

Database File Disk Distribution Terms Description

Redo log groups Use at least two groups with three files in each group. Placethe groups on separate, individual disks for redundancyand performance. Separate the online redo logs disk fromother database activity and from the archived redo logs.Place the redo logs on fast devices, which do not need to belarge storage devices.

Database control files Use at least three control files, located on different disks.

RAID DevicesThe use of RAID devices is transparent to Oracle. All the features specific to RAID configurations arehandled by the operating system and not Oracle.

RAID ConfigurationThe use of RAID devices differs according to the Oracle file type. Data files and archive logs can be placedon RAID devices because they are accessed randomly. Do not place redo logs on RAID devices because theyare accessed sequentially and performance is enhanced by having the disk drive head near the last writelocation. Oracle recommends that you mirror redo files. RAID is easier to use than the Oracle techniques fordata placement and striping.

Keep in mind the following RAID configuration recommendations.

n RAID usually affects write operations more than read operations. This is especially true where parityneeds to be calculated (RAID 3, RAID 5, and so on).

n You can place online or archived redo log files on RAID 1 devices. Do not use RAID 5. Place TEMPtablespace data files on RAID 1 devices, instead of RAID 5, because the streamed write performance ofdistributed parity (RAID 5) is not as good as that of simple mirroring (RAID 1).

n You can use swap space on RAID devices without affecting Oracle.

Table 7‑4. RAID devices

RAID Type of RAID Control File Database FileRedo log orTemporary Archive File

0 Striping Avoid OK Avoid Avoid

1 Shadowing OK OK Recommended Recommended

0+1 Striping+Shadowing

OK Recommended Avoid Avoid

Chapter 7 Planning Requirements for vRealize Business

VMware, Inc. 59

Page 60: vRealize Business Installation and Administration Guide ... · Using or Linking Veritas NetBackup with vRealize Business 54 ... vRealize Business Installation and Administration Guide

Table 7‑4. RAID devices (Continued)

RAID Type of RAID Control File Database FileRedo log orTemporary Archive File

3 Striping withstatic parity

OK Avoid whenthis data fileinvolves heavywrite operations

Avoid Avoid

5 Striping withrotating parity

OK Avoid whenthis data fileinvolves heavywrite operations

Avoid Avoid

RAID 0 does not provide protection against failures. RAID 0 requires a strong backup strategy. RAID 0+1 isrecommended for database files because it avoids hot spots and provides the best possible performanceduring a disk failure. The disadvantage of RAID 0+1 is its costly configuration.

Use the highest RPM disks for temporary and redo logs. Use as many controllers as you can in the array,and ensure that you place the redo log groups on different controllers. You can use the followingconfigurations to combine RAID 0 and RAID 1.

n RAID 0+1 is implemented as a mirrored array with segments that are RAID 0 arrays.

n RAID 10 is implemented as a striped array whose segments are RAID 1 arrays.

Do not confuse RAID 0+1 with RAID 10. A single drive failure can cause the whole array to become a RAID0 array.

Advantages and Disadvantages of RAID ImplementationUsing Redundant Array of Inexpensive Disks in vRealize Business has advantages and disadvantages.Based on the vRealize Business application requirement, the system administrator decides the level of RAIDto be used.

Advantages of RAIDn RAID 1 is useful in systems where complete redundancy of data is necessary and disk space is readily

available.

n With RAID1 the writes to the memory are much faster.

n Inclusion of RAID improves the system performance by distributing I/O load equally on severalphysical servers.

n RAID supports creation of logical files that are larger than the maximum size supported by theoperating system.

Disadvantages of RAIDn RAID 1 is not suited for systems with large data files and less disk space.

n Data striping might not allow you to locate single data file on specific physical drive.

n Some of the application tuning capabilities might be lost due to data striping.

n Data recovery becomes time consuming, as all the disks that are a part of the logical RAID device mustbe involved (for read and write operating) in the recovery process.

NOTE Data striping is the technique of segmenting logically sequential data, such as a file, so thatconsecutive segments are stored on different physical storage devices.

vRealize Business Installation and Administration Guide

60 VMware, Inc.

Page 61: vRealize Business Installation and Administration Guide ... · Using or Linking Veritas NetBackup with vRealize Business 54 ... vRealize Business Installation and Administration Guide

Creating RTF Templates 8In the vRealize Business application, you can use the data tags and flow control tags from the dynamic taglibrary to customize the default system templates and create RTF templates for Word documents. Thesedocuments are distributed to customers and other vRealize Business users.

This chapter includes the following topics:

n “Dynamic Tag Library,” on page 61

n “Agreement Documentation Tags,” on page 62

n “Report Documentation Tags,” on page 66

n “Advanced Options,” on page 69

n “Troubleshooting the RTF Template,” on page 70

Dynamic Tag LibraryThe dynamic tag library is used by advanced vRealize Business system users to create RTF templates foragreement and report documents.

Location of System TemplatesYou can use tags to customize the default system templates in the DF-Config/presentation folder.

Table 8‑1. Default Templates

Template Description

slaOverview.rtf Used for exporting agreements to Word.

templateOverview.rtf Used for exporting master agreements to Word.

report.rtf Used for exporting reports to Word.

In addition to default templates, you can use tags to create private templates for Export Using Layout andBooklet actions.

About Dynamic Tags in vRealize BusinessThe dynamic tag library contains data access tags and flow control tags.

Dynamic tags must be enclosed in angle brackets (<>). The first character after the opening angle bracketmust be either a dollar sign ($) or a pound sign (#).

Data Access

VMware, Inc. 61

Page 62: vRealize Business Installation and Administration Guide ... · Using or Linking Veritas NetBackup with vRealize Business 54 ... vRealize Business Installation and Administration Guide

The syntax for the basic data access tag is

$OBJECT_COMPONENT.PROPERTY_COMPONENT.

A declaration statement is used to create the OBJECT_COMPONENT. The declaration statement defines areference to an object. This reference is also used to retrieve data from that object. The declaration statementuses the following format.

<#set ($referenceName = OBJECT_DECLARATION)>

For more information, see “Agreement Documentation Tags,” on page 62 and “Report DocumentationTags,” on page 66.

Flow Control

The syntax for the basic flow control is:

#CONTROL_COMMANDS (for example:foreach/if/end/set).

Agreement Documentation TagsYou can use the dynamic tag library to create agreement documents. The output documents contain severalelements that are controlled by tags. The elements, agreements, revisions, categories, and business rules, arenested by dependent loops in that order.

AgreementsAgreements define the service agreement parameters between the serving system or staff, the provider, therecipient, and the customer . There can be multiple services, and therefore multiple agreements, for arelationship .

The following example declares an agreement.

<#set ($mySla = $slaRtfFactory.sla(“mySLA”))>

Table 8‑2. Agreement Documentation Tags

Documentation Tag Description

$slaRTFFactory.currentSla() Retrieves the agreement that is currently in the context.Use this tag for the Export to Word feature.

$slaRTFFactory.sla("Your SLA Name") Retrieves the agreement with the name Your SLAName. Use this tag when documenting an agreementfrom the Booklet feature .

$slaRTFFactory.sla("SLA ID") Retrieve the agreement with the ID SLA ID. Use thistag when documenting an agreement from the Bookletfeature.

$slaRTFFactory.template("Your Master AgreementName")

Retrieve the master agreement with the name YourMaster Agreement Name. Use this tag whendocumenting an agreement from the Booklet feature.

$slaRTFFactory.template("Master Agreement ID") Retrieve the master agreement with the ID MasterAgreement ID. Use this tag when documenting anagreement from the Booklet feature.

NOTE If the name is not unique, an error message appears. If you receive an error message, the MasterAgreement ID is used.

vRealize Business Installation and Administration Guide

62 VMware, Inc.

Page 63: vRealize Business Installation and Administration Guide ... · Using or Linking Veritas NetBackup with vRealize Business 54 ... vRealize Business Installation and Administration Guide

You can concatenate the groupByCategory tag to the agreement declaration statement. Use it to divide thebusiness rules into a group according to the system default category, usually Classification. The advantageis that you can process the business rules according to the groups.

<#set ($mySla = $slaRtfFactory.sla(“mySLA”).groupByCategory())>

Property TagsThe property tags are used in the PROPERTY_COMPONENT part of the basic access tag. In this list, mySla is usedas a reference name, but any other name that is defined in the declaration can be used.

Table 8‑3. PROPERTY_COMPONENT Tags

Property component Description

$mySla.name The name of the agreement.

$mySla.description The description of the agreement.

$mySla.providerName The provider name of the agreement.

$mySla.customerName The customer name of the agreement.

$mySla.udfs The level user defined field list.

$mySla.binaryDTOs Agreement level user defined field list of type attachment

<$mySla.groupByType> If the value is 1, display a flat list of all the business rules inthe revision. If the value is 2, display business rules directlyunder the revision under the General Terms AndConditions category. Business rules appear under servicesin a tree structure within the Services category.

<$mySla.revisions> A list of Revisions.

<$mySla.revisions.size()> Number of revisions.

The name of the field can be used for fields that are not predefined such as agreement fields in user definedfields. For example, if an agreement field is named my_sla_field_name, the tag <mySla.y_sla_field_name>receives the value of this field if the field is defined as an agreement user defined field on the agreement.

Agreement RevisionsRevisions contain the content of an agreement for a specified time. For example, one revision might spanJanuary to June and another, with different business rules, might span July to December.

Revision LoopingThe revisions loop is nested under the main statement in the agreement documentation tag. This followingexample loop is for processing all the revisions.

<#foreach ($revision in $mySla.revisions)> <#end>

Property TagsThe property tags are used in the PROPERTY_COMPONENT part of the basic access tag.

Chapter 8 Creating RTF Templates

VMware, Inc. 63

Page 64: vRealize Business Installation and Administration Guide ... · Using or Linking Veritas NetBackup with vRealize Business 54 ... vRealize Business Installation and Administration Guide

Table 8‑4. PROPERTY_COMPONENT Tags

Property Component Description

<$revision.revisionNumber> The number of the Revision.

<$revision.status> Possible values include:n 1 - Active revisionn 2 - Pending revisionn 3 - History revisionn 4 - Draft revisionn 5 - Awaiting approvaln 6 - Revoked revisionThe values are used in an <#if>conditional tag.

<$revision.startDate> The start date of a Revision.

<$revision.endDate> The end date of a Revision.

<$revision.description> The description of a Revision.

<$revision.objectives> A list of business rules. For more information, see “Business Rules,” on page 65Business Rules.

<$revision.objectives.size()> A list of business rules. Relevant if $mySla.groupByType ==1.

<$revision.generalTermsAndConditions Objectives> A list of business rules directly under revision (type 0).Relevant if $mySla.groupByType == 2.

<$revision. generalTermsAndConditionsObjectives. size()> A list of business rules that do not belong to a service.Relevant for cross-service business rules.

<$revision.groupByServices> A list of business rules under services. Relevant if$mySla.groupByType == 2.

<$revision.groupByServices.size()> A list of business rules that belong to a service, groupedby service.

<$revision.udfs> Revision level user defined fields.

<$revision.binartDTOs> Revision level user defined fields list of type attachment.

CategoriesA category is a type of business rule. vRealize Business includes general terms and conditions, businessservices and technical services, performance, financial, and specification categories.

Category LoopingThe groupByType tag is located under the agreement itself.

<#if ($mySla.groupByType == X)> ... <#end>

If you set groupByType == 1, the business rules are shown in a flat list. If you set groupByType == 2, thebusiness rules are displayed under the category in which they reside. The general terms and conditionscategory for the business rules reside directly under the revision. The services category for the business rulesreside in a tree-like structure.

vRealize Business Installation and Administration Guide

64 VMware, Inc.

Page 65: vRealize Business Installation and Administration Guide ... · Using or Linking Veritas NetBackup with vRealize Business 54 ... vRealize Business Installation and Administration Guide

Business RulesA business rule is a tool that measures service performance. The business rule defines the agreementbetween parties and measures performance according to a defined breach condition.

Business Rule LoopingThe business rule loop is nested under the revisions loop in the agreement documentation tag, or under thecategories loop in the revision. The following example is a loop for processing all the business rules.

<#foreach ($objective in $revision.objectives)>

These are the possible data tags that are grouped by Type 1. They appear directly under the revision.

Table 8‑5. Business Rule Objective Tags

Tag Description

<$objective.name> The name of the business rule.

<$objective.statement> The business rule statement.

<$objective.metricName> The name of the business rule template.

<$objective.targets> A list of the business rule targets.

<$objective.udfs> The business rule level user defined fields.

<$objective.binaryDTOs> A list of attachment type in user fields for a business rule.

The target loop is nested under the revisions loop in the agreement documentation tag, or under thecategories loop in the revision. The following example is a loop for processing all the targets.

<#foreach ($target in $objective.targets)>

Table 8‑6. Business Rule Target Tags

Tags Description

<$target.type> The type of the business rule target.

<$target.value> The value of the business rule target.

Category LoopingThe category loop is nested under the revisions loop in the agreement documentation tag, or under thecategories loop in the revision. The following example is a loop for processing all the categories.

<#foreach ($objective in $revision.generalTermsAndConditionsObjectives)>

The following are the possible data tags for the categories.

Table 8‑7. Business Rule Objective Tags

Tag Description

<$objective.name> Name of the business rule.

<$objective.statement> Business rule statement.

<$objective.metricName> The name of the business rule template.

<$objective.targets> List of the business rule targets.

<$objective.udfs> Business rule level user defined fields.

<$objective.binaryDTOs> Business rule level user defined fields list of typeattachment.

Chapter 8 Creating RTF Templates

VMware, Inc. 65

Page 66: vRealize Business Installation and Administration Guide ... · Using or Linking Veritas NetBackup with vRealize Business 54 ... vRealize Business Installation and Administration Guide

These are the possible data tags for the components.

<#foreach ($component in $revision.groupByServices)>

Table 8‑8. Business Rule Component Tags

Tag Description

<$component.type> Type of the component.n type == 2. Service foldern type == 1. Servicen type == 12. Service instancen type == 6. Business rule

If component.type == 6, then additional tags are uses for the components.

Table 8‑9. Component Type == 6

Tag Description

<$component.name> Name of the business rule.

<$component.statement> Business rule statement.

<$component.metricName> The name of the business rule template.

<$component.targets> List of the business rule targets.

<$component.udfs> Business rule level user defined fields.

<$component.binaryDTOs> Business rule level user defined fields list of typeattachment.

Report Documentation TagsYou can use the dynamic tag library to create report documents. There are several elements, which arecontrolled by tags, in the output document. The elements, parent reports, child reports, and report filters arenested by dependent loops in that order.

Parent ReportsThese reports are the main reports that are displayed when you use report documentation tags to presentreports in output for the export to word or booklet features. If any drill down reports extend from the parentreport, they appear as child reports in the output.

Declare a ReportThis statement declares a report.

<#set ($myReport = $reportRtfFactory.report(“my report”))>

The complete OBJECT_DECLARATION statement for report documentation tags is as follows.

($reportRtfFactory.report(publishedReportNameOrld, withReportString, withDrillDownsString,

allowViewingShadowObjectiveString, restrictToApprovedDateString, nodeIdString, dimIdString).

Use this statement for the export to word feature as well as when documenting a report from the bookletfeature.

vRealize Business Installation and Administration Guide

66 VMware, Inc.

Page 67: vRealize Business Installation and Administration Guide ... · Using or Linking Veritas NetBackup with vRealize Business 54 ... vRealize Business Installation and Administration Guide

Table 8‑10. Parameters for Report Documentation Tags

Parameter Meaning Possible Values

publishedReportNameOrld Report name or ptree_base_idof the report

Report name

withReportString Includes report in booklet True or False.

withDrillDownsString Includes one or moredrilldowns

True or False.

allowViewingShadowObjectiveString For shadow objective True or False.

restrictToApprovedDataString For approved data True or False.

nodeIdString Node ID Node ID

dimIdString Dimension ID

Use these other possible OBJECT_DECLARATION statements for report documentation tags in this order.

$reportRtfFactory.report(publishedReportNameOrld)

$reportRtfFactory.report(publishedReportNameOrld, withReportString)

$reportRtfFactory.report(publishedReportNameOrld, withReportString,withDrillDownsString)

$reportRtfFactory.report(publishedReportNameOrld, withReportString, withDrillDownsString,

allowViewingShadowObjectiveString)

$reportRtfFactory.report(publishedReportNameOrld, withReportString, withDrillDownsString,

allowViewingShadowObjectiveString, restrictToApprovedDateString)

$reportRtfFactory.report(publishedReportNameOrld, withReportString, withDrillDownsString,

allowViewingShadowObjectiveString, restrictToApprovedDateString),nodeIdString)

Property TagsThe property tags are the valid data tags for PROPERTY_COMPONENT for parent reports.

NOTE In this list, myReport is used as the reference name, but any other name that is defined in thedeclaration can be used.

Table 8‑11. Property Tags for Parent Reports

Tag Description

<$myReport.reportTitle> The report title.

<$myReport.startTime> The report start date.

<$myReport.reportPeriod> The report period.

<$myReport.aggregationPeriod> The report aggregation period.

<$myReport.reports> The report lists the actual reports. The report also containschild reports of composite reports or report plus itsdrilldowns. For more information see “Child Reports,” onpage 68.

<$myReport.specificReportName> The name of the specific report. This tag can be used onlyin the booklet and not in export to word. In the case ofexport to word, the field will be empty.

<$myReport.reports.size()> Is the number of reports. For more information see “ChildReports,” on page 68.

Chapter 8 Creating RTF Templates

VMware, Inc. 67

Page 68: vRealize Business Installation and Administration Guide ... · Using or Linking Veritas NetBackup with vRealize Business 54 ... vRealize Business Installation and Administration Guide

Table 8‑11. Property Tags for Parent Reports (Continued)

Tag Description

<$myReport.reportDuration> Calculates the values for displaying the report duration, asin current 12 Month (Jul 1, 2007 - Jul 1, 2008).

<$myReport.hasAnyData> The true or false value indicates that there is a child reportthat does or does not contain data. This is useful foromitting reports from booklets that are empty.

Child ReportsChild reports present additional information that is not included in the parent reports. Child reports arereports that allow you to navigate through the parent reports.

Report LoopingUse a report loop to process multiple reports. This sample loop processes all of the reports. In case of acomposite report, the report loop processes all displayed reports. In all other cases, this loop processes themain report and any drilldown reports.

<#foreach ($report in $myReport.reports)><#end>

Property TagsThese property tags are used in the dynamic tag language to display elements in child reports

Table 8‑12. Child Report Property Tags

Tag Description

<$report.reportTitle> The report title.

<$report.reportDescription> The description of the report.

<$report.startTime> The report start time.

<$report.reportPeriod> The report period.

<$report.context> BU or relationship context, if one exists.

<$report.aggregationPeriod> The report aggregation period.

<$report.sortedByDescription> The description of the sorting for the report.

<$report.reportBody> The report body.

<$report.reportBody(“width in pixels”, “height in pixels”, “pdf_shift”)>> All parameters are optional. However, you can usethese parameters as follows: width and heightvalues retrieve the report body with the specificsize in pixels. The default values for width is 500pixels and for height is 375 pixels. Theseparameters are relevant only for graphical reportsand do not affect table reports. The pdf_shiftparameter adds pixels before the report in a PDFoutput for display purposes. Its default value is400 pixels.

<$report.filtersSummary> A list of filters. See “Report Filters,” on page 69.

<$report.filtersSummary.size()> The number of filters. See “Report Filters,” onpage 69.

<$report.hasData> This true or false value indicates that this childreport does or does not contain data.

vRealize Business Installation and Administration Guide

68 VMware, Inc.

Page 69: vRealize Business Installation and Administration Guide ... · Using or Linking Veritas NetBackup with vRealize Business 54 ... vRealize Business Installation and Administration Guide

Report FiltersReport filters process input with the requested filter values to refine the report output.

<#foreach ($filter in $report.filtersSummary)><#end>

The loop is used to processing all the filters.

Table 8‑13. Report Filters Options

Tag Description

<$filter.title> Filter title

<$filter.formattedFilterValues> Filter values

Advanced OptionsThis option is used to modify standard dynamic tag library elements to improve the agreement or reportoutput.

Filters for Agreement Documentation TagsAgreement documentation tags define the object itself.

An agreement documentation tag is composed of an OBJECT_DECLARATION statement with, optionally,one or more filter statements separated by a period. Agreement documentation tags can use several filterstatements.

Table 8‑14. Filter Statements

Filter Statement Desciption

filterRevisions(“filter string on the revision name”) Retrieves only the revisions whose namescontain the parameter .

currentRevision( ) Retrieves only the current revision of theagreement.

filterSlos(“filter string on the Business Rule name”) Retrieves only the business rules whose namesmatch the parameter.

filterByCategory(“category value") Retrieves only the business rules that have thevalue category in the system default category.They are usually Classification. Categories aremetric fields.

Concatenating Filters and FunctionsDifferent filters and group-by functions can be chained together in any order for multiple option filtering.

However, it is a best practice to perform the group by task at the end. If more than one group-by function isactivated, only the last function is used.

The following example retrieves the agreement with revisions that include interested revision in theirnames, with business rules that include interested business rule in their names, and access to the businessrules grouped by the category in "my category".

$slaRTFFactory.sla(“your Agreement name”)

filterRevisions(“interested revision”)

filterSlos(“interested Business Rules”)

groupByCategory(“my category”)

Chapter 8 Creating RTF Templates

VMware, Inc. 69

Page 70: vRealize Business Installation and Administration Guide ... · Using or Linking Veritas NetBackup with vRealize Business 54 ... vRealize Business Installation and Administration Guide

Condition TagsThis tag is used to exclude empty fields that not mandatory. For example, Description, are intentionally leftblank.

Use if flow control tag to exlude a field.

If the data in the data access tag is empty, then if tag results as false and no output is displayed. The<#else> tag is not mandatory.

<#if Data Access tag>

<#else>

<#end>

NOTE Example

<#if ( $revision.description )>

Description: <$revision.description>

<#else>

No description is available

<#end>

Another use for the conditional tag is with Boolean data. When the data access tag returns a Boolean value,this data is the input for the if clause, as the following example shows.

<#if ($mySla.isTemplate())>

Some Master Agreement data

<#end>

Counter for ListsYou can use the <$velocityCount> tag in every #foreach loop to get the index of current iteration, startingfrom one. The result is the number as a text field that can be placed anywhere in a sentence. This does notimplement Microsoft Word numbering.

Another option for numbering is to use Microsoft Word numbering in the template in the #foreach tag.When the loop runs, the Microsoft Word numbering is activated and increases the number. The result is aMicrosoft Word numbering scheme.

Troubleshooting the RTF TemplateYou can troubleshoot problems with the dynamic tag library.

Incorrect SyntaxIncorrect syntax is handled as part of the template body text.

Problem

When there is an incorrect tag syntax in the template.

Cause

If a tag syntax is wrong, for example, if it uses the wrong property name, the tag is handled as part of thetemplate body text. If the #set command is wrong, all of the tags that use this reference are handled as partof the template body text.

vRealize Business Installation and Administration Guide

70 VMware, Inc.

Page 71: vRealize Business Installation and Administration Guide ... · Using or Linking Veritas NetBackup with vRealize Business 54 ... vRealize Business Installation and Administration Guide

Solution

There is no solution.

No Data AvailableWhen there is no data available for a tag, an empty string is displayed as an output.

Problem

There is no data entered in a tag.

Cause

If a tag does not have the required data available, the system retrieves an empty string output. Retrieval ofempty string can be configured to other text in the EMPTY_FIELDS_VALUE_FOR_RTF_BOOKLET propertyin serviceflow.properties. If data is accessed through an empty list iteration, no data is generated.

Solution

There is no solution.

No Name or No Unique NameIf a non-unique name or no name for an RTF template is used then an error message is displayed .

Problem

An error message appears when there is no name for a report or agreement or if the report or agreementname is not unique.

Cause

When there is no unique name or no name given for an RTF template.

Solution

Assign a name to the report or agreement and verify that it is unique.

Chapter 8 Creating RTF Templates

VMware, Inc. 71

Page 72: vRealize Business Installation and Administration Guide ... · Using or Linking Veritas NetBackup with vRealize Business 54 ... vRealize Business Installation and Administration Guide

vRealize Business Installation and Administration Guide

72 VMware, Inc.

Page 73: vRealize Business Installation and Administration Guide ... · Using or Linking Veritas NetBackup with vRealize Business 54 ... vRealize Business Installation and Administration Guide

Administration Procedure

VMware, Inc. 73

Page 74: vRealize Business Installation and Administration Guide ... · Using or Linking Veritas NetBackup with vRealize Business 54 ... vRealize Business Installation and Administration Guide

vRealize Business Installation and Administration Guide

74 VMware, Inc.

Page 75: vRealize Business Installation and Administration Guide ... · Using or Linking Veritas NetBackup with vRealize Business 54 ... vRealize Business Installation and Administration Guide

Configuring vRealize BusinessSystem Parameters 9

If you are an advanced user of vRealize Business, such as an administrator, you can configure theinfrastructure, dimensions, database, and engine parameters to improve the vRealize Business systemperformance.

This chapter includes the following topics:

n “Infrastructure Configuration Parameters,” on page 75

n “Dimensions Configuration Parameters,” on page 77

n “Database-Related Configuration Parameters,” on page 77

n “Engine-Related Configuration Parameters,” on page 78

n “Security Configuration Parameters,” on page 80

Infrastructure Configuration ParametersYou can use these properties to configure infrastructure parameters.

Table 9‑1. Infrastructure Configuration Parameters

Property Name Default Value Description

ENCRYPT_DS_DB_PASSWORD True Set the ENCRYPT_DS_DB_PASSWORD to Trueto encrypt the data source databasepassword.

IS_SCHEDULER 1 Set the IS_SCHEDULER to 1 to determinewhether a node should run the schdueler.

SCHEDULER_KEEP_ALIVE True Set SCHEDULER_KEEP_ALIVE to True to startthe scheduler.

PORTAL_HOMEPAGE_REPORT_ON_CLICK_ENABLED False SetPORTAL_HOMEPAGE_REPORT_ON_CLICK_ENABLED to add the onClick code to the portalhomepage report.

PORTAL_HOMEPAGE_REPORT_ON_CLICK_ENABLED Set this value to indicate which menu isavailable to set the portal report homepage.

SERVER_URL http://localhost:8080/jserf/

Set SERVER_URL to specify thevRealize Business Server URL.Bootstrap.setUrlPrefix function usesthis to set this value.

VMware, Inc. 75

Page 76: vRealize Business Installation and Administration Guide ... · Using or Linking Veritas NetBackup with vRealize Business 54 ... vRealize Business Installation and Administration Guide

Table 9‑1. Infrastructure Configuration Parameters (Continued)

Property Name Default Value Description

EXTERNAL_SERVER_URL http://localhost:8080/jserf/

Set EXTERNAL_SERVER_URL to specify theURL that users use to access thevRealize Business.NOTE This address might be different thanthe SERVER_URL if the vRealize Business isfronted by a proxy.

TRIGGER_POINTS_ON False Set TRIGGER_POINTS_ON to True to enableor disable trigger points control in the reportheader.

LDAP_INTEGRATION_MODE False Set the LDAP_INTEGRATION_MODE to false tospecify the user management screen LDAPintegration. Use as specified in thedeployed .war.

MAX_OBJECTS_TO_LOAD 7000 Set the MAX_OBJECTS_TO_LOAD value tospecify the import export dependency treeconfiguration.

DRILL_DOWN_NAVIGATION_LINKS_ VISIBLE True Set the DRILL_DOWN_NAVIGATION_LINKS_VISIBLE to true to specify the drilldownnavigation links in the parent report.

NUM_WORK_QUEUE_THREADS 50 Set the NUM_WORK_QUEUE_THREADS value tospecify the number of worker threads forasynchronous processing, excludingprecacher.

REPORT_RUNTIME_CACHE_SIZE 15 Set the REPORT_RUNTIME_CACHE_SIZEvalue to specify the number of reportheaders that can be in the cachesimultaneously. If the report headers areextremely large, you might need to decreasethis value to prevent out-of-memoryexceptions.

COST_MODEL_UPLOAD_SHOW_END_TIME True Set COST_MODEL_UPLOAD_SHOW_END_TIMEto True to allow mapping an END_TIMEfrom the data.

UI_HELP_INDEX_URL Set UI_HELP_INDEX_URL value to view theindex file of the user interface help menu.

UI_HELP_CONTENT_URL Set UI_HELP_CONTENT_URL value to viewthe content of the user interface help.

UI_LOGOUT_ENABLED True Set UI_LOGOUT_ENABLED to True to enablethe logout button.

UI_LOGOUT_REDIRECT URL Set UI_LOGOUT_REDIRECT to redirect to adifferent URL after logout, this is is used forSSO logout.

ENABLE_BREADCRUMB Edit the serviceflow.properties locatedunder <ITBM_instance_folder>/DF-config. Add ENABLE_BREADCRUMBS =true. Logout and re-login or refresh thebrowser.

vRealize Business Installation and Administration Guide

76 VMware, Inc.

Page 77: vRealize Business Installation and Administration Guide ... · Using or Linking Veritas NetBackup with vRealize Business 54 ... vRealize Business Installation and Administration Guide

Dimensions Configuration ParametersYou can use these properties to configure dimensions parameters.

Table 9‑2. Dimension Configuration Parameters

Property Name Default Value Description

DIM_REC_TITLE_PREFIX Prefixes and suffixes added todimension nodes. These parametersare typically used for recursivedimension nodes such as NameGlobal. For example, the recursivenode for dimension node USA is (USAGlobal).

DIM_REC_TITLE_SUFFIX \Global)

DIM_REAL_TITLE_PREFIX

DIM_REAL_TITLE_SUFFIX

LIVECHAT_ENABLED False Enables chat integration withLivePerson athttp://www.liveperson.com/.

LIVECHAT_SITE_ID Life chat site ID

LIVECHAT_IMAGE_URL http://server.iad.liveperson.net/hcp/Gallery/ChatButton-Gallery/English/General/1a

Image URL. This is the default.

LIVECHAT_REFERER_OVERRIDE Override referer sent to live chat. If notset, the current URL is used.

LIVECHAT_EXTRA_PARAMS Pass extra values to LiveChat operator.The format is param=value. Severalparameters might be defined,delimited by semicolons:param1=value;param2=value; ...

Database-Related Configuration ParametersYou can use these properties to configure database-related parameters.

Table 9‑3. Database-Related Configuration Parameters

Property Name Default Value Description

QUERY_FACTORY_CLASS com.digifuel.serviceflow.infra.common.db.querybuilder.QueryComponent

Do not modify this property. Thisparameter is used only ifvRealize Businessruns on serversother than Oracle.

INDEX_TABLESPACE=

TABLE_TABLESPACE=

Use Oracle defaults Oracle stores tables in tablespaces.Each tablespace uses its own files onthe server’s disks. For betterperformance, keep tables and theirindexes in separate tablespaces thatare stored on different physical disks.These properties tell vRealize Businesswhich tablespaces to use for tablesand which to use for indexes. If theseproperties are not set,vRealize Business uses the Oracledefaults.

Chapter 9 Configuring vRealize Business System Parameters

VMware, Inc. 77

Page 78: vRealize Business Installation and Administration Guide ... · Using or Linking Veritas NetBackup with vRealize Business 54 ... vRealize Business Installation and Administration Guide

Table 9‑3. Database-Related Configuration Parameters (Continued)

Property Name Default Value Description

MAX_EXTENTS Unlimited Oracle tables are divided into extents.This property sets the maximumnumber of extents to use for tables,after which tables cannot grow in size.

ORACLE_ENTERPRISE_EDITION True If the database server is an Oracleenterprise edition, vRealize Businessoptimizes itself by using theenterprise features.

DB_CONN_LOGIN_TIMEOUT 60 Specifies the timeout value forconnections to the database. Theadministrator decides the value of thisto be in seconds or milliseconds. Ifyou encounter connection timeoutproblems, you can increase this value.

Engine-Related Configuration ParametersYou can use these properties to configure engine-related parameters.

Table 9‑4. Engine-Related Configuration Parameters

Property Name Default Value Description

UIENGINE_JOB_RUN_TIMES

ENGINE_JOB_RUN_TIME_COLORS

3600,7200, above black,orange,red. Seconds and colors map that definesthe font colors of runtime values.

STATISTICS_DURATION_OF_RUNTIME_THRESHOLDS

20,60,100 The thresholds, in percent, for runtimeduration in flows.

STATISTICS_MINIMUM_PERCENTAGE_THRESHOLD

60 On the flow/operator statistics page,the minimum runtime, in seconds,required for the UI to display thevisual indicators of a significantpercentage of runtime.

ENGINE_JOB_STUCK_TIME

FLOW_MANAGER_DATES_FORMAT

43200 The time, in seconds, after which thejob is considered stuck. Default is 12hours, after the transaction shouldhave been rolled back.

OLD_SLO_TO_CALCULATE 1 Engine Properties.

FUTURE_SLO_TO_CALCULATE -1

CONTINUE_CALCULATING_PARAMSET_FOR

60

FLOW_RUNNER_MAX_RETRY 2

EXPLAIN_PLAN_THRESHOLD 5 Minimum threshold, in minutes, forqueries to have their explain planlogged.

LOG_FILE_HOURS_AHEAD 49 Flat file adaptor look ahead setting.

IGNORE_NEW_LINE_TERMINATED True Determines whether the lines that donot end with an end-of-line areignored in flat file adaptors.

LOG_FILE_CHARSET Flat file adaptor charset. Possiblevalues are UTF-8 or ISO-8859-1.

vRealize Business Installation and Administration Guide

78 VMware, Inc.

Page 79: vRealize Business Installation and Administration Guide ... · Using or Linking Veritas NetBackup with vRealize Business 54 ... vRealize Business Installation and Administration Guide

Table 9‑4. Engine-Related Configuration Parameters (Continued)

Property Name Default Value Description

LOG_FILE_WILDCARD_BRACKETS_CONSTANTS

True Determines whether to treat bracketsas constants in wildcard templates.Otherwise they are treated as defininga set of characters. Default is false.Examples: The templatec:\logs\data[12345].csv matches iftrue: c:\logs\data[12345].csv ONLY.If false:c:\logs\data1.csv,c:\logs\data2.csv,c:\logs\data3.csv,c:\logs\data4.csv,c:\logs\data5.csv.

DEFAULT_ADAPTOR_TIME_ZONE America/ New_York Default time zone for adaptors. Stringvalue, for example, GMT,America/New_York.

ADAPTOR_DB_SYBASE_NO_NESTED_QUERY True Some early versions of Sybase do notallow nested queries.

DO_NOT_ABORT_RUNNING_JOBS False Disable Abort Job feature. The AbortJob feature might not work with somedrivers and databases, and mightresult in exceptions. Set this flag totrue to bypass.

DEFAULT_USE_FREEZE_DATE False Default of the use_freeze_dateproperty of newly created flows.

DEFAULT_USE_MANY_TRANS True Default of the use_many_transproperty of newly created flows.

RUN_DDL_MODE 0 Affects how DDLs are run. 0 for usingStatement, 1 for using the saferPrepared Statement.

BREACH_ADJUSTMENT_TIMEOUT 10 When adjusting a breach, the engineopens a new thread, and tries to adjustthe breach dynamically. The user doesnot wait for this breach to be adjusted,but the thread does not try to adjustthe breach for more thanBREACH_ADJUSTMENT_TIMEOUTseconds. When the flow runs, all theadjustments that did not happenadjust.

ENGINE_DEFAULT_RETRY_COUNT 1 Number of times to retry by default ifa batch runs a job and fails.

ENGINE_RESPAWN_COUNT 1 Number of times to retry if a batchtries to run a job, but the job does notstart running. Minimum value = 1.

ENGINE_RESPAWN_INTERVAL_SECS 1 Number of seconds to wait betweenretries if a batch attempts to run a job,but the job does not start running.Minimum value = 1.

ENGINE_DEFAULT_RETRY_COUNT 3 Number of retry attempts if a batchruns a job and the job fails.

ENGINE_RESPAWN_COUNT 3 Number of times the system shouldrespawn the job.

Chapter 9 Configuring vRealize Business System Parameters

VMware, Inc. 79

Page 80: vRealize Business Installation and Administration Guide ... · Using or Linking Veritas NetBackup with vRealize Business 54 ... vRealize Business Installation and Administration Guide

Table 9‑4. Engine-Related Configuration Parameters (Continued)

Property Name Default Value Description

ENGINE_RESPAWN_INTERVAL_SECS 20 Interval that the system must waitbetween respawn attempts if a batch torun another job, but that job does notstart at all and the system tries torespawn it.

DISABLE_FLOW_PARALLELISM False If true, then the FlowRunnerJet uses aregular connection instead of a parallelconnection.

MINOR_MUTEX_ABORT_TIME 30 Minimum time to wait for the MinorMutex Abort feature. If set to 0, featureis disabled.

Security Configuration ParametersYou can use these parameters to define the behaviour of the application if you enter values for fields whichare case sensitive. You can also decide whether to add security filters to a user, based on their role. You canuse this parameter to specify whether to encrypt Tomcat and LDAP credentials.

Table 9‑5. Security Parameters

Property Name Default Value Description

FORCE_USER_LOWERCASE False Setting this parameter to true helpsyou to solve the authentication-authorization case mismatch problems.If this property is set, users alwayscreate, import, and log in using lowercase letters.

SECURE_HEADER_FILTERS True Information revealed in reports isprimarily determined by the user’srole. In general, filtered information isnot role-dependent. This propertycontrols whether to add security to thefilters.

ENCRYPT_TC_ENV True Determines whether to keep Tomcatdata source password and LDAPcredentials encrypted.

vRealize Business Installation and Administration Guide

80 VMware, Inc.

Page 81: vRealize Business Installation and Administration Guide ... · Using or Linking Veritas NetBackup with vRealize Business 54 ... vRealize Business Installation and Administration Guide

Troubleshooting vRealize Business 10This section provides information about the problems that you might encounter when usingvRealize Business and provides possible solutions.

This chapter includes the following topics:n “User Cannot Access vRealize Business Application,” on page 81

n “Adaptors Fail when You Import Data from an SQL Table,” on page 82

n “No Data in Database Adaptor for a Non-Oracle Server,” on page 82

n “Flow Calculations are not Visible,” on page 82

n “No Data Passes through the Identify Operator,” on page 83

n “Unable to View Existing Reports,” on page 83

n “Not Receiving Email for Report Distributions,” on page 83

n “Unable to Send Email to Lotus Notes Users,” on page 84

n “Unable to Synchronize LDAP and Active Directory Users,” on page 84

n “Failed to Create a Document,” on page 85

User Cannot Access vRealize Business ApplicationUser is unable to access vRealize Business.

Problem

User cannot accessvRealize Business application at certain instances.

Cause

A user might have an incorrect URL path, authentication credentials to access thevRealize Businessapplication or might be accessing an incorrect application deployment

Solution

1 Verify that the application was successfully deployed.

2 Verify the path of the URL to vRealize Business.

3 Verify that the ID and password are correct and typed accurately.

VMware, Inc. 81

Page 82: vRealize Business Installation and Administration Guide ... · Using or Linking Veritas NetBackup with vRealize Business 54 ... vRealize Business Installation and Administration Guide

Adaptors Fail when You Import Data from an SQL TableAdaptors fail when you import data from an SQL table.

Problem

Adaptors fail from an SQL table.

Cause

A blank space in an SQL table can cause an adaptor to fail when you import data from an SQL table.

Solution

In an SQL query, use square brackets ( [ ] ) around the table or field that contains a blank space in the tableor field name for an SQL database. Use double quotation marks ( " " ) around the table or field for an Oracledatabase.

No Data in Database Adaptor for a Non-Oracle ServerUser might not see any data in vRealize Business Database Adaptor from a non-Oracle server.

Problem

If you have a database adaptor from a non-Oracle database server, it might not contain any data.

Cause

The database server might not support JDBC connections.

Solution

1 Verify that your database server supports JDBC connection.

2 In the vRealize Business domain under the appropriate application server path, download and installthe correct JDBC driver that matches your database.

Table 10‑1. JDBC Driver

Option Description

Tomcat ${instance_path}/../lib

Flow Calculations are not VisibleYou are unable to see any calculations for the flow you created.

Problem

You create a flow in vRealize Business and commit it, but you are unable to see any calculations for yourflow.

Solution

Select Data Processing > Flow Manager and navigate to the appropriate flow.

vRealize Business Installation and Administration Guide

82 VMware, Inc.

Page 83: vRealize Business Installation and Administration Guide ... · Using or Linking Veritas NetBackup with vRealize Business 54 ... vRealize Business Installation and Administration Guide

No Data Passes through the Identify OperatorIf you create a flow with an identify operator, no data passes through the identify operator, hence nobreaches are generated.

Problem

When you create a flow with an Identify operator and activate the job for it, data does not pass through theidentify operator and no breaches are generated

Cause

Undefined resources, incorrect resource mapping, and mapping dates that do not include dates of the datamight cause this problem.

Solution

1 Ensure that you define the resources at the designer and verify that the resources were defined exactlyas they appear in the data, including spaces.

2 Ensure that the resource mapping is correct. When you map the resource, ensure that the mappingdates include the date of the data, even if that date is in the past.

Unable to View Existing ReportsWhen you attempt to view an existing report, an error message appears.

Problem

When you attempt to view an existing report, a Cannot load Report error message appears.

Solution

Check the report definitions to verify that they are defined correctly.

Not Receiving Email for Report DistributionsYou do not receive emails for defined report distributions.

Problem

You are unable to receive emails notifications for alerts or report distributions that should be sent on setschedules.

Cause

Mail settings or SMTP settings are configured incorrectly.

Solution

1 From vRealize Business, select Tools > System Definitions > Backend Processes > Mail Distributor.

2 Verify that the user name, password, and SMTP address are correct.

3 If you change the mail settings, restart the Mail Distributor service.

4 Verify that SMTP configuration is correct.

5 Check that no special permissions are preventing emails from being sent.

For example, the SMTP allows only certain sender addresses to send emails.

Chapter 10 Troubleshooting vRealize Business

VMware, Inc. 83

Page 84: vRealize Business Installation and Administration Guide ... · Using or Linking Veritas NetBackup with vRealize Business 54 ... vRealize Business Installation and Administration Guide

Unable to Send Email to Lotus Notes UsersYou are unable to send emails to Lotus Notes users.

Problem

Lotus Notes does not support HTML anchors in emails.

Cause

This limitation might result in a problem when you send a report that contains links in an email to LotusNotes users.

Solution

vRealize Businessincludes a workaround to remove the links between a report and its drilldowns.

Procedure

1 Add the LOTUS_NOTES_COMPATIBILITY flag to the serviceflow.properties file .

2 Set the value to either True or False.

Table 10‑2. LOTUS_NOTES_COMPATIBILITY Table

Value Behavior

True Links do not work in any email application. This is true for table and graphicalreports. Use this option when email recipients use Lotus Notes.

False Do not remove the links. Links work in email applications except for LotusNotes.

Unable to Synchronize LDAP and Active Directory UsersSynchronization for LDAP and Active Directory fails when the principle password expires .

Problem

The principle password that connects the user to the LDAP or AD repository. If this password expires, theseerror messages appear in the log file.

n Failed to connect to set up the CTX

n Cannot get Users

Cause

The new password does not match the encrypted password in the ldap.properties file.

Solution

1 Open the DF-Config/ldap.properties file.

2 In the password entry, type the new password.

3 Restart the server.

The new password is now encrypted in the ldap.properties file.

Define the principle user's password as one that never expires.

vRealize Business Installation and Administration Guide

84 VMware, Inc.

Page 85: vRealize Business Installation and Administration Guide ... · Using or Linking Veritas NetBackup with vRealize Business 54 ... vRealize Business Installation and Administration Guide

Failed to Create a DocumentWhen you configure the SSL system, the vRealize Business application displays an error message.

Problem

When you configure the SSL system, if the configuration is incorrect, the application displays the followingerror message:

Failed to create document. (code 3209).

Solution

u If you see Failed to create document. (code 3209), set the SERVER_URL property in theserviceflow.properties file.

Chapter 10 Troubleshooting vRealize Business

VMware, Inc. 85

Page 86: vRealize Business Installation and Administration Guide ... · Using or Linking Veritas NetBackup with vRealize Business 54 ... vRealize Business Installation and Administration Guide

vRealize Business Installation and Administration Guide

86 VMware, Inc.

Page 87: vRealize Business Installation and Administration Guide ... · Using or Linking Veritas NetBackup with vRealize Business 54 ... vRealize Business Installation and Administration Guide

Index

Aactivation 29adaptors fail 82administrator 25Advanced Options 69Advanced Settings 27advantages of RAID 60Agreement DocumentsAgreement

Documents 62Agreement Documentation Tags 69Agreements 62Application tablespace 58applications 19auditing reports 26authentication 23, 30

Bbackend scheduling 52backup and recovery 53Batch Procedure Whitelist Properties 40business rules 57Business Rules 65business rulesbusiness rules 62

Ccache management 52Capacity Factors 57Categories 64Category Looping 64Character compatibility 51Child Reports 68cluster 14cluster configuration 14, 52common 26Concatenating Filters 69Concatenating Functions 69Condition Tags 70configuration 45Configuration Files 39configuring 7configuring vRealize Business system

parameters 75content packages 26, 27content source 18

cost model 31Counter for Lists 70Create RTF Templates 61creating 12, 13custom 19custom installation 33, 37custom package 26customer 20

Ddata validation 26Data Access 61Data Storage 58Data tags 61database 11, 18database administrator 12database parameters 22database adaptor 82database instance 22database schema 18database-related configuration Parameters 77Dimensions Configuration Parameters 77disadvantages of RAID 60disk space 57Documentation TagsDocumentation Tags 62dump file 19Dynamic Tag Library 61Dynamic Tags 61

Eelements 62email settings 46Enable data table archiving 49Encrypting user passwords 48Engine-Related Configuration Parameters 78environment variables 11Export to Word 61

Ffail over 14failed to create document 85file system backups 53Flat file properties 39flow calculations 82

VMware, Inc. 87

Page 88: vRealize Business Installation and Administration Guide ... · Using or Linking Veritas NetBackup with vRealize Business 54 ... vRealize Business Installation and Administration Guide

Flow Control 61flow control tags 61flow size calculation 57

GGeneric recovery 55groupByType 64guide 7

Hhost 22https parameters 22

Iidentify operator, no data 83import data 82Incorrect Syntax 70infrastructure configuration parameters 75installation mode 17Installation Procedures 19Installation Summary 29installation type 17Installation Checks 29installing 7, 9, 16integration 29IT Financial Manager 19

JJava Runtime Environmenet 38jdbc connection 82

Kkey 40

LLDAP 23–25LDAP connection 24license 41LINUX configuration 13load balancer 14Log In 45Lotus notes 52Lotus Notes users 84

Mmail 28mail distributor 28manage budget 31mapping file 30Master Agreement ID 62media failure scenarios 54modify OOTB 31

Nno data 71No Name or No Unique Name 71not receive emails 83

Oobjects 27Oracle database 12oracle parameters 11Oracle parameters 11Oracle user 13Oracle database backups 53, 54oracle users 11

PParent Reports 66password encryption 40Password encryption 48performance 12Planning requirements 57portfolio 19, 26Post installation tests 46post-installation 7Property Tags 68PROPERTY_COMPONENT

PROPERTY_COMPONENT 63

RRAID Configuration 59RAID devices 59RDBMS 23Recommended Backup Strategy 53Recovery 54Redo log groups, Database control files 59Report Documentation Tags 66Report filters 69report.rtf 61reports 27Revision Looping Revision Looping 63revisions 62Revisions Revisions 63roles 26RTF Template 70

SSecurity Parameters 80server parameters 21ServiceFlow Properties 39session replication 52set time zone 47setting 47Setting Oracle parameters 47

vRealize Business Installation and Administration Guide

88 VMware, Inc.

Page 89: vRealize Business Installation and Administration Guide ... · Using or Linking Veritas NetBackup with vRealize Business 54 ... vRealize Business Installation and Administration Guide

SLA 19SLA ID 62SLA Name 62SLA Manager 26slaOverview.rtf 61slaRTFFactory.currentSla() 62SNMP Traps 49SQL scripts 26SSL configuration 50SSL Configuration 51SSO 23standard roles 26Start server 29Synchronization for LDAP and Active

Directory 84synchronizing users, synchronizing groups 25System 58system global area, process global area 11System Templates 61system types 20

Ttablespaces 12templateOverview.rtf 61test tomcat 51time zone 47token 30Tomcat 21Tomcat and LDAP configuration passwords 49troubleshooting 81troubleshooting workaround 81

Uunable to access vRealize Business 81Unable to View Reports 83UNIX configuration 13update 38upgrade 33upgrade application 33, 35upgrade database 33, 36upgrade and custom installation 33upgrade application and database 33upgrade schema 19upgrading 9users 23, 25

Vverify installation 45Veritas NetBackup 54

WWAR file 26

workload analysis 59

Index

VMware, Inc. 89

Page 90: vRealize Business Installation and Administration Guide ... · Using or Linking Veritas NetBackup with vRealize Business 54 ... vRealize Business Installation and Administration Guide

vRealize Business Installation and Administration Guide

90 VMware, Inc.