vrealize Business Installation and Administration Guide

Transcription

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

2 vrealize Business Installation and Administration Guide You can find the most up-to-date technical documentation on the VMware Web site at: The VMware Web site also provides the latest product updates. If you have comments about this documentation, submit your feedback to: Copyright 2014 VMware, Inc. All rights reserved. Copyright and trademark information. VMware, Inc Hillview Ave. Palo Alto, CA VMware, Inc.

3 Contents About This Book 7 Installation 1 Preparing to Install vrealize Business 11 Oracle Parameter Values 11 Creating Tablespaces 12 Create Oracle Users 13 Set the UNIX or LINUX Configuration 13 About Installing vrealize Business in a cluster environment 14 2 Install vrealize Business 15 Run vrealize Business Installer 16 Select the Installation Mode 17 Select the Installation Type 17 Select the Database Schema configuration 18 Select a Source for the Database Schema Content 18 Select Installation s 19 Select Applications to Install 19 Select a System Type 20 Provide Server Parameters for the Application Server 21 Configure Oracle Database Parameters 22 Define a User Authentication Type 23 Define a Lightweight Directory Access Protocol Connection 24 LDAP Synchronization for Users or Groups 25 Create an User for Logging in to vrealize Business 25 Select an Application File for vrealize Business installation 26 Content Packages in vrealize Business 26 Select Content Packages 27 Configure Advanced Settings 27 Configure a Mail Distributor 28 Complete the Installation 29 vrealize Business Advanced or Enterprise with vrealize Business Standard Integration Activation 29 3 Upgrading and Custom Installations 33 Upgrade vrealize Business Application and Database 33 Upgrade the vrealize Business Application 35 Upgrade the Database 36 Custom Installation 37 Update the Java Runtime Environment Version 38 VMware, Inc. 3

4 vrealize Business Installation and Administration Guide 4 Configuration Files 39 Working with Configuration Files in vrealize Business 39 ServiceFlow Properties 39 About Flat Files 39 Batch Whitelist Properties 40 vrealize Business Key 40 vrealize Business License 41 Post-Installation 5 Post Installation Tasks 45 Log In to vrealize Business 45 Verify Basic vrealize Business Features 46 Configure Settings 46 Set the Time Zone 47 Oracle Parameters Customized for vrealize Business 47 Encrypting Passwords 48 Enable Data Table Archiving 49 Sending Traps with SNMP 49 Enabling SSL for Tomcat 50 Test the SSL Configuration 51 Verifying Character Compatibility 51 Supporting Lotus Notes 52 Configure vrealize Business Cluster Installation 52 6 Backup and Recovery 53 Backup Strategies 53 Oracle Database Backups 54 Using or Linking Veritas NetBackup with vrealize Business 54 Recovery 54 7 Planning Requirements for vrealize Business 57 Factors Affecting the Disk Capacity Calculation 57 Configuring the Database Disk 58 RAID Devices 59 8 Creating RTF Templates 61 Dynamic Tag Library 61 Agreement Documentation Tags 62 Report Documentation Tags 66 Advanced Options 69 Troubleshooting the RTF Template 70 Administration 4 VMware, Inc.

5 Contents 9 Configuring vrealize Business System Parameters 75 Infrastructure Configuration Parameters 75 Dimensions Configuration Parameters 77 Database-Related Configuration Parameters 77 Engine-Related Configuration Parameters 78 Security Configuration Parameters Troubleshooting vrealize Business 81 User Cannot Access vrealize Business Application 81 Adaptors Fail when You Import Data from an SQL Table 82 No Data in Database Adaptor for a Non-Oracle Server 82 Flow Calculations are not Visible 82 No Data Passes through the Identify Operator 83 Unable to View Existing Reports 83 Not Receiving for Report Distributions 83 Unable to Send to Lotus Notes Users 84 Unable to Synchronize LDAP and Active Directory Users 84 Failed to Create a Document 85 Index 87 VMware, Inc. 5

6 vrealize Business Installation and Administration Guide 6 VMware, Inc.

7 About This Book The vrealize Business Advanced and Enterprise Installation and Administration Guide provides information about installing, upgrading, configuring, customizing, backing up and recovering procedures. It also provides information about post-installation procedure, which includes backup and recovery, planning capacity, administrative tasks and troubleshooting vrealize Business. Intended Audience This information is intended for users who wants to install, upgrade or perform post installation tasks on vrealize Business. The information is written for experienced Windows, UNIX, and Linux system administrators. VMware Technical Publications Glossary VMware Technical Publications provides a glossary of terms that might be unfamiliar to you. For definitions of terms as they are used in VMware technical documentation, go to VMware, Inc. 7

9 Installation VMware, Inc. 9

11 Preparing to Install 1 vrealize Business 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 the environment variables. This chapter includes the following topics: Oracle Parameter Values, on page 11 Creating Tablespaces, on page 12 Create Oracle Users, on page 13 Set the UNIX or LINUX Configuration, on page 13 About Installing vrealize Business in a cluster environment, on page 14 Oracle Parameter Values The 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 dedicated database, disable this feature. The values for the parameters are for the 64-bit version of Oracle. If you are using the 32-bit version, modify the 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 SHARED_POOL_ SIZE LOG_BUFFER OPTIMIZER_ MODE Specifies the size of the default buffer pool for buffers of the primary block size. Specifies the size of SQL statement cache. This parameter is used to enable reuse of statements. Specifies the number of buffers, each size of the system page located in System Global Area (SGA) and as a result of the changed data written to the redo log files. Enables the Oracle Cost-Based Optimizer when statistics are available. Unset the parameter. Unset the parameter. Unset the parameter. ALL_ROWS VMware, Inc. 11

12 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 WORKAREA_SIZE_ POLICY SESSION_CACHED_ CURSORS PROCESSES SESSIONS JAVA_POOL_SIZE DB_WRITER_ PROCESSES PGA_AGGREGATE_ TARGET SGA_TARGET SGA_MAX_SIZE MEMORY_TARGET MEMORY_MAX_ TARGET Specifies the type of SQL statements that can share the same cursors. Setting the value of this parameter to Exact allows only statements with identical text to share the same cursor. This parameter determines whether Oracle should automatically allocate in the Process Global Area (PGA) and SGA, or that these areas will be allocated manually. Specifies the number of cursors to cache per session. Displays the maximum number of processes. Displays the maximum number of sessions. Specifies (in bytes) the size of the Java pool, from which the Java memory manager allocates most Java state during runtime execution. The number of background database writer processes. Target size for the aggregate PGA memory consumed by the instance. Specifies the total size of all SGA components. Specifies the maximum size of the SGA for the lifetime of the instance. Specifies the Oracle system-wide usable memory. Only the value Exact is supported and certified. AUTO Unset the parameter. 3 Unset the parameter. Unset the parameter. Unset the parameter. 5GB Unset the parameter. Creating Tablespaces Oracle stores data logically in tablespaces and physically in datafiles associated with the corresponding tablespace. Before you install vrealize Business, you must create permanent tablespaces, which are used to store user data and user created objects. You can also create temporary tablespaces that are used to store data 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 to optimize performance. Table 1 2. vrealize Business Permanent Tablespaces Tablespace DFL_DATA DFL_IDX Description Main tablespace that vrealize Business uses. Default storage location for indexes. Segments are the storage objects in the Oracle database. You can manage these segments locally with automatic segment allocation enabled. Enable logging for these segments. Consult the database administrator for appropriate sizing of the tablespaces. 12 VMware, Inc.

13 Chapter 1 Preparing to Install vrealize Business The size of the undo tablespace is a product of the undo retention period and the volume of data updated by vrealize Business. The default undo retention period is 3 hours. In most cases, 10GB of undo space is sufficient. Create a temporary tablespace with an initial size of 10GB. Consult the database administrator for appropriate sizing of the tablespaces. Create Oracle Users Each vrealize Business installation must have an Oracle user to which all vrealize Business objects, Oracle tablespaces, and procedures are associated. 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 Configuration Before you install vrealize Business on a UNIX or LINUX system, configure the environment variable and kernel parameters. 1 To define the correct file permissions to a particular user, configure an existing UNIX user profile by setting 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: :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 Save this configuration and reboot. VMware, Inc. 13

14 vrealize Business Installation and Administration Guide 6 Set the display environment variable again. About Installing vrealize Business in a cluster environment In a cluster environment, several computers run vrealize Business and share processing by using a load balancer. In a cluster installation, you can configure one computer to handle the backend processes and install the other computers in the cluster as frontend instances. See Install Application Server as a Frontend Instance on Configure Advanced Settings, on page 27. vrealize Business cluster environment is composed of three main components. A load balancer - to handle load distribution between available cluster nodes. For example, Apache httpd server. Multiple application servers - to support several user requests. You can install Tomcat instance as a member of cluster. See Provide Server Parameters for the Application Server, on page 21. An Oracle database - to store data. Installing vrealize Business in a cluster environment has several advantages. Scalability - A single application server can handle a limited number of client requests. So, you can add multiple application servers to distribute the load, allowing concurrent users. Fail over recovery - In case of failure in a server to handle a client request, other severs in the cluster takes over the job to handle the requests. Availability - When some application servers are offline for maintenance and recovery, users can access vrealize 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 VMware, Inc.

15 Install vrealize Business 2 To install vrealize Business, you must perform series of steps. 1 Run vrealize Business Installer on page 16 You can install vrealize Business using the installer. You can perform a complete installation or select components to install. 2 Select the Installation Mode on page 17 You can install vrealize Business in either evaluation mode or license mode. 3 Select the Installation Type on page 17 You can select the vrealize Business installation types whether you want to perform a complete or custom installation, upgrade, or create or upgrade only the database schema. 4 Select the Database Schema configuration on page 18 During vrealize Business installation, you must determine the configuration for the database schema. 5 Select a Source for the Database Schema Content on page 18 You can select the source of the database schema content. you can use the scripts or a dump file. 6 Select Installation s on page 19 You can select or view a list of procedures that run during the installation. 7 Select Applications to Install on page 19 While installing vrealize Business, you can select applications to install such as Portfolio, SLA Manager, or IT Financial Manager. If you plan to use a custom dump file for the content source, the installation wizard does not display the Applications page. 8 Select a System Type on page 20 You can install vrealize Business on several different system types, such as single or multiple customers, alliance, or shared services. 9 Provide Server Parameters for the Application Server on page 21 The Tomcat application servers accept different parameters. 10 Configure Oracle Database Parameters on page 22 vrealize Business uses Oracle as its database server. So, you must specify database parameters during vrealize Business installation. 11 Define a User Authentication Type on page 23 During installation, you can define the authentication method by which users access vrealize Business. The method also determines where the user credentials are stored. VMware, Inc. 15

16 vrealize Business Installation and Administration Guide 12 Define a Lightweight Directory Access Protocol Connection on page 24 You need to define the Lightweight Directory Access Protocol (LDAP) connection, if you select the user authentication type as LDAP during installation. 13 LDAP Synchronization for Users or Groups on page 25 During installation, you can synchronize the users or groups or else the users are copied from the LDAP repository. 14 Create an User for Logging in to vrealize Business on page 25 You must create a user to log in to vrealize Business. The user created during the vrealize Business installation is given administrative privileges. 15 Select an Application File for vrealize Business installation on page 26 You must provide the location of the application file (.war file) to install vrealize Business. 16 Content Packages in vrealize Business on page 26 Content packages contain additional objects such as reports, adaptors, and role definitions, which are not included in vrealize Business, by default. 17 Select Content Packages on page 27 During 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. 18 Configure Advanced Settings on page 27 You can customize your installation by defining several, more complex, advanced settings options. If you do not define these options during installation, you can define them later. 19 Configure a Mail Distributor on page 28 To configure a mail distributor service by setting the user name and password. 20 Complete the Installation on page 29 You can review your vrealize Business installation settings and complete the installation. 21 vrealize Business Advanced or Enterprise with vrealize Business Standard Integration Activation on page 29 The vrealize Business administrator can enable the integration between vrealize Business Advanced and Enterprise and vrealize Business Standard. Run vrealize Business Installer You can install vrealize Business using the installer. You can perform a complete installation or select components to install. Prerequisites Meet the hardware and software requirements. See the System Requirements Guide for additional information. Log in to the machine as an administrator. Download the vrealize Business installer. 16 VMware, Inc.

17 Chapter 2 Install vrealize Business 1 Run the vrealize Business installer. u u On Windows, navigate to the vrealize Business installation files and double-click the ITBM- Installer_BuildNumber.jar file. On UNIX or Linux, run the <JAVA_HOME>\bin\java -jar ITBM-Installer_BuildNumber.jar command. 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 Mode You can install vrealize Business in either evaluation mode or license mode. Prerequisites Run the vrealize Business installer and proceed from the Welcome screen. u Select an installation mode and click Next. Evaluation Mode. This is the default mode. Licensed Mode. If you have the vrealize Business license, select this option and type the license key in the text box. What to do next Select the installation type whether you want to install or upgrade. Select the Installation Type You can select the vrealize Business installation types whether you want to perform a complete or custom installation, upgrade, or create or upgrade only the database schema. Prerequisites Run the vrealize Business installer and select the installation mode. u Select one of the installation types and click Next. Complete. To install vrealize Business for the first time. This is the default mode. Upgrade. To upgrade your existing vrealize Business version. Custom. To install only the selected components. Database Schema. To create or upgrade your database schema. What to do next Select the database schema. VMware, Inc. 17

18 vrealize Business Installation and Administration Guide Select the Database Schema configuration During vrealize Business installation, you must determine the configuration for the database schema. Prerequisites Run the vrealize Business installer and select the installation type. 1 On the Database Schema page, create a new schema or upgrade an existing one. Do Not build Database Schema: The installer uses the existing database schema, without creating a new schema or upgrading the existing schema. NOTE The Do Not build Database Schema option requires a valid database schema that is compatible with the vrealize Business version that is being installed. Create New Database Schema: The installer uses the scripts to create a new schema. For this option, you need the user name and password that have been created in the database. If you already have a schema in this location, a warning appears at the end of the installation configuration. This option is selected, by default. Upgrade Database Schema: The installer uses upgrade scripts that are available with the installation files to upgrade the existing schema to the vrealize Business version that is being installed. 2 Click Next. What to do next Select the source of the schema content. Select a Source for the Database Schema Content You 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. 1 On the Database Schema Content Source page, select the source of the schema content. Default scripts: The installer uses scripts for the latest build included with the Installation wizard. This option is selected by default. 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. 18 VMware, Inc.

19 Chapter 2 Install vrealize Business Select a Custom Dump File You 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 Content Source page. 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 the server. If you want to upgrade the dump file, complete the installation and rerun the installation wizard with the Upgrade Schema option only. 2 Click Next. What to do next Select the application server or Web server. Select Installation s You 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. 1 On the Installation s page, review the list of procedures that the installer performs. The options on the Installation page varies based on the installation type selected. All the options are selected by default. If you are installing vrealize Business for the first time on the computer, the Tomcat Installation and Tomcat Instance Configuration options appear. If you have selected Upgrade Database Schema on the Database Schema page or Custom on the Database Schema Content Source page, you can select or deselect the Redefine Applications to Install and Modify vrealize Business System Type options. 2 Click Next. What to do next Define the server parameters. Select Applications to Install While installing vrealize Business, you can select applications to install such as Portfolio, SLA Manager, or IT Financial Manager. If you plan to use a custom dump file for the content source, the installation wizard does not display the Applications page. Prerequisites Select Default Scripts as the source for the database schema content. VMware, Inc. 19

20 vrealize Business Installation and Administration Guide 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 and system type configuration pages are not applicable or available. What to do next Select a System Type. Select a System Type You 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. 1 Select a system type. System Type Single Customer Alliance Multiple Customers Shared Services Description An instance of vrealize Business has exactly one customer. vrealize Business calculates cost and resource statistics for the customer. An instance of vrealize Business has exactly one customer, but might be serviced by one or more providers. vrealize Business calculates statistics for the customer. A service provider running an instance of vrealize Business has multiple customers and might have one or more providers as well. vrealize Business calculates cost and resource statistics for the service provider running vrealize Business. An instance of vrealize Business has multiple customers and providers represented by other divisions within the organization. vrealize Business calculates statistics for the organization running the instance of vrealize Business. You selection in vrealize Business determines whether to present data filtered by either customers or by 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, select Manage 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 Provider Approval. 5 Click Next. What to do next Specify Server Parameters. 20 VMware, Inc.

21 Chapter 2 Install vrealize Business Provide Server Parameters for the Application Server The 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. 1 Update the values on the Server Parameters page. u Tomcat NOTE For Installation, upgrade and redeployment or when you select Upgrade as the installation type, only Server Instance is displayed on the Server Parameters page. Option Installation base directory Server Instance Install HTTP Connector HTTP Listen Port Install HTTPS (SSL) Connector SSL Listen Port Shutdown Port Java Home Install as Windows Service Service name Installation File Permissions Install as Cluster Node Action Click Select Folder to select the base directory where you want the embedded vrealize Business Tomcat server to be installed. Type a unique name for this instance of vrealize Business. Select this option to enable install vrealize Business over HTTP protocol. Type a valid port number. Select this option to install and authenticate vrealize Business by using Secure Socket Layer (SSL) protocol. Type the valid port number for secure requests Enter a port for vrealize Business to shut down, when it detects an activity on the port. The default port is Click Select Folder to browse to the Java Home directory. vrealize Business Installer installs Java 1.7.0_72, by default. NOTE It is mandatory to provide your own JDK (1.7 and above) path for the Linux or Unix systems. Select this option to start Tomcat as a Windows Service when vrealize Business starts. Type a name for the service. If you do not specify a name, vrealize Business uses the server instance name. A new parameter is added to the Server Parameters of the Installer. This is used while executing a recursive chmod command. The default value for this parameter is go-rwx and this restricts the permissions to other users. This means that only the user who has installed the product have the eligibility to run the parameter using the default settings. The parameter is only applied to the Unix based systems like Linux and Mac. 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 server external software, or hardware to determine the cluster type. Install as a Windows service Install as a cluster node Install a cluster load balancer The Tomcat cluster feature listens at ports 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. VMware, Inc. 21

22 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) Parameters For the Tomcat application server, you can provide key parameters by typing their values or selecting a file to copy the values. Prerequisites Run the vrealize Business installer and select the Tomcat with SSL. 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 to copy. What to do next Specify your database parameters. Configure Oracle Database Parameters vrealize Business uses Oracle as its database server. So, you must specify database parameters during vrealize Business installation. Prerequisites Install Oracle client and create an Oracle user. Also, you have installed Oracle client and created Oracle user. 1 On the Database Parameters page, provide credentials for accessing the Oracle database. 22 VMware, Inc.

23 Chapter 2 Install vrealize Business 2 Define the Oracle instance by using Custom Oracle Connect Descriptor. Provide the host, port, and instance name. Option Oracle Host Oracle Port Oracle Database Instance Name (SID) Action The name of the system where Oracle is running. The Oracle port number, the port where an Oracle service is listening. By default, the value is set to The Oracle instance name provided when you installed Oracle. Use an Oracle connect descriptor. Option Use Custom Oracle Connect Descriptor Custom Oracle Connect Descriptor Action Select the check box. Enter the connect descriptor string. 3 Click Next. What to do next NOTE You must use the Custom Oracle Connect Descriptor option only when a complex connect descriptor is required. Define authentication types. Define a User Authentication Type During installation, you can define the authentication method by which users access vrealize Business. The method 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 User Authentication page is not available or applicable. 1 Select the authentication type. RDBMS - The RDBMS authentication type uses vrealize Business database tables to verify and store user credentials. The administrator creates users in vrealize Business, which stores user credentials database tables. LDAP (including Active Directory) - The LDAP authentication type uses an LDAP repository to verify users. When users, whose credentials are stored in an LDAP repository, try to log in to vrealize Business, the vrealize Business sends a verification request to LDAP. If the users are confirmed and have valid credentials, vrealize Business approves the login request. Single Sign-On - The Single Sign-On (SSO) method does not provide authentication. SSO users log in to the vrealize Business from a secure environment, for example, a company portal. VMware, Inc. 23

24 vrealize Business Installation and Administration Guide 2 To copy all existing and new users from the Lightweight Directory Access Protocol (LDAP) repository to vrealize Business, select Enable user synchronization. If you do not enable user synchronization, You must create LDAP users in the vrealize Business with the same user name as in the LDAP repository. Use this option if you have a small number of LDAP users. You do not need to create the users in vrealize Business manually. Do not use this option if you do not want to grant permission for all of your LDAP users to access vrealize 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 by selecting Enable local users. By default, when you use an LDAP repository, you cannot add local users to your vrealize Business system. This option can be useful to create a test user. 4 Click Next. If you have selected LDAP, provide the required information on the LDAP Connection page. If you have select SSO, provide additional SSO configuration details: a b c d e On the SSO Configuration page, select an SSO type. If you are using the HTTP header parameter method, type a user ID parameter name. In the Logout Redirect Page text box, type the URL where your vrealize Business installation directs users when they log out. Click Next. If you are using NTLM, provide the required information on the NTLM SSO Parameters page and click Next. What to do next Create or add users. Define a Lightweight Directory Access Protocol Connection You need to define the Lightweight Directory Access Protocol (LDAP) connection, if you select the user authentication type as LDAP during installation. Prerequisites Run the vrealize Business installer and specify the user authentication type as LDAP. 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. 24 VMware, Inc.

25 Chapter 2 Install vrealize Business What to do next Specify the LDAP synchronizations details. LDAP Synchronization for Users or Groups During installation, you can synchronize the users or groups or else the users are copied from the LDAP repository. Prerequisites Run the vrealize Business installer and specify the LDAP connection. 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 for synchronizing the groups. 3 You can define the users or groups at a later point by selecting the checkbox to allow empty user or group query results. 4 Click Next. What to do next Specify system administrator user details. Create an User for Logging in to vrealize Business You must create a user to log in to vrealize Business. The user created during the vrealize Business installation is given administrative privileges. Prerequisites Run the vrealize Business installer and the select the user authentication type. 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 Administrator User page is not available or applicable. What to do next Provide application location to install. VMware, Inc. 25

26 vrealize Business Installation and Administration Guide Select an Application File for vrealize Business installation You 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. u On the Application Location page, select the location of the.war file and click Next. Option Default (File bundles with installer) Custom (File from disk) Description Select a location of the.war within the installer file. 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 Business Content packages contain additional objects such as reports, adaptors, and role definitions, which are not included in vrealize Business, by default. Table 2 1. Available Content Packages Package Standard Roles Common Data Validation Reports Auditing Reports SLA Manager Portfolio IT Financial Manager Custom Package Additional SQL script Description Includes a predefined, standard set of roles and actions that eliminate the need to create roles in vrealize Business. You can view these roles in the Administration module. Contains basic objects that vrealize Business requires, but do not specifically belong in other content packages. Includes a group of special adaptors and reports that display summaries and details of data validation problems. These objects are located in the vrealize Business Designer Workshop under the Data Validation folder. Provides a basic set of auditing reports and adaptors. These objects are located in the vrealize Business Designer Workshop under the Audit folder. Contains adaptors, flows, BRTs, and reports. It supplies the SLM menu in vrealize Business with compliance, credit, and bonus reports by using tiered calculations by using DFL_BREACHES. These objects are located in the vrealize Business Designer Workshop under the SLM folder. Imports the initialization and population batch, which includes several procedures that create the package tables and populates them by extracting data from the audit tables. The batch is scheduled to run every 30 minutes. When this package is installed, all of the content reports are filled with data within 30 minutes. These objects are located in the vrealize Business Designer Workshop and Report Management under the Service Portfolio Management folder. 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 Workshop under the ITFM Content folder. Includes a custom content package during vrealize Business installation. Runs additional SQL scripts. These scripts run at the end of the vrealize Business installation process. 26 VMware, Inc.

27 Chapter 2 Install vrealize Business Select Content Packages During 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. 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 b c Select the Custom Package check box. Click Select File to browse to the file. In the Select File dialog box, navigate to the file and click Select File. 3 Click Next. Configure Advanced Settings You can customize your installation by defining several, more complex, advanced settings options. If you do not define these options during installation, you can define them later. Prerequisites Run the vrealize Business installer and select the content packages. 1 Select a SQL script file that runs after installation. a b Click Select File to browse to the file. 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, for example, 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 a cluster environment. For security reasons, consider dedicating two servers. One server runs all of the backend processes, including the vrealize Business engine, which collects data from adaptors. The other server, which points to the same database, works as the frontend server. No backend processes run on this server. Because this server references the same database, reports and other vrealize Business objects are updated with the appropriate information. However, the processing and data collection occur on the backend instance server. NOTE This option is available only for cluster installation. A cluster configuration with frontend instances guarantees that only one server in the cluster handles the backend processes such as the mail distributor and data purging. To define a system as a frontend instance after installation, set the IS_SCHEDULER property in DFConfig/serviceflow.properties to 0. VMware, Inc. 27

28 vrealize Business Installation and Administration Guide 3 To define an alternative URL for your vrealize Business server, type the server URL in the Server URL text box. By default, the server URL uses localhost. You can type an IP address for the server URL. If you have a UNIX 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 External Server URL text box for security purposes. NOTE After installation, you can assign a URL to the EXTERNAL_SERVER_URL property in DFConfig/serviceflow.properties as required. 5 In a cluster environment, secure your database coonnections. a b From the first system that was installed in the cluster, copy the key from the DF-Config/ITBM.key file. 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 and paste the key in the text box while installing each instance. 6 Select an alternative location for the flat_file.properties file. a b Click Select File to browse to the file. 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 which flat file adaptors can upload data. 7 Select an alternative location for the dos_command_whitelist.properties file. a b Click Select File to browse to the file. 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 that engine batches can run. What to do next To configure a mail distributor. Configure a Mail Distributor To configure a mail distributor service by setting the user name and password. 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. 28 VMware, Inc.

29 Chapter 2 Install vrealize Business What to do next Review your installation settings and complete the installation procedure. Complete the Installation You can review your vrealize Business installation settings and complete the installation. Prerequisites Run the vrealize Business installer and select the required configurations. 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, you might not want to automatically start the server. 2 On the Installation Checks page, select whether you want to delete temporary files that the install process generates. If you want to keep the temporary files to review the installation log, you can delete these files manually after the installation finishes. 3 Click Next. The installer starts verifying all the configurations that you specified. The verification process might take 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. You can make changes by navigating back or see installation details. The output statements and errors appear 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 Business Standard Integration Activation The vrealize Business administrator can enable the integration between vrealize 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. For additional information on token, see vrealize Business Standard Installation and Administration Guide. VMware, Inc. 29

30 vrealize Business Installation and Administration Guide 1 Open the command line terminal and navigate to your vrealize Business server instance folder and run the 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 Business installation and can be found at <Your vrealize Business Installation Path>\Tomcat-<Tomcat version>\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 Standard Connection Details in vrealize Business, on page 30 Update vrealize Business Standard Connection Details in vrealize Business To 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, see vrealize Business Standard Installation and Administration Guide. 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 Business Standard Server>: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 field value 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 Business In order to co-relate between vrealize Business Standard and vrealize Business Advanced and Enterprise you need to provide several mapping files. 1 Click Costing > Upload Data Sources. 2 Upload a mapping file, for each of the four mapping file adaptors: VMware ITBM Standard Consumer Mapping VMware ITBM Standard Project Mapping 30 VMware, Inc.

31 Chapter 2 Install vrealize Business VMware ITBM Standard Public Cloud Account Mapping VMware ITBM Standard Public Cloud Offering Mapping 3 Click Save. Manage the Budget in vrealize Business Advanced or Enterprise with vrealize Business Standard To export the information from the report that should be used in vrealize Business Advanced or Enterprise and to create users with specifc permissions. Prerequisites Verify that you are connected to vrealize Business Standard. 1 In vrealize Business Standard, select Administration > Business Management and expand vrealize 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 click Flow 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 Business User Guide. 7 Set the roles for the two users: Director of Cloud with domain set to All Business Entities Business Group Manager with domain set to Business Group NOTE Time zone of vrealize Business Standard should be before the time zone of vrealize Business Advanced or Enterprise inorder for the batch to fetch the data. Modify the Out-of-the-Box Cost Model If you do not have vrealize Business Standard and is interested in using the same flow, to upload the data you 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. 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. Allocation rules to private cloud are such that any cost coming into the group is split between CPU and RAM unless the cost originates from the storage or backup cost group which is routed to the storage cost object under private cloud. A new cost group called public cloud that is based on a dimension of the same name. The dimension has two hierarchy levels representing a public cloud vendor and the services or offerings acquired from the vendor and a new expense object is dedicated to public cloud expenses. VMware, Inc. 31

33 Upgrading and Custom Installations 3 You can upgrade vrealize Business using the installer. You can either upgrade an installation or can perform select installation procedures by using custom installations. NOTE To upgrade from a version earlier than ServiceFlow to the current version of vrealize Business, upgrade your system to ServiceFlow and then run the installer for vrealize Business. This chapter includes the following topics: Upgrade vrealize Business Application and Database, on page 33 Upgrade the vrealize Business Application, on page 35 Upgrade the Database, on page 36 Custom Installation, on page 37 Update the Java Runtime Environment Version, on page 38 Upgrade vrealize Business Application and Database You upgrade the application and database only when a new.war file is deployed into the system. The wizard recognizes that an installation already exists and prompts you for only the necessary information to upgrade the system. Prerequisites Remove any trailing backslash characters when setting the Server Instance. This is known to create installation difficulties during upgrades. From version 7.5 or later versions, shared dashboards are no longer supported. Any dashboards that exist in the My Reports hierarchy under the incoming shared reports folder will be deleted. To preserve shared dashboards, you must move them into the My Reports hierarchy by using either the Move menu option 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. From Version 7.5 onwards, Out-of-the-Box roles are overwritten during an upgrade. If changes are made to any of these roles, the administrator must update these roles manually after the upgrade. In general, if many changes are required to the Out-of-the-Box roles, create a copy of each role and maintain all modifications in the copied roles instead of the Out-of-the-Box roles. VMware, Inc. 33

34 vrealize Business Installation and Administration Guide 1 Run the vrealize Business installer. System Windows Non-Windows Description Navigate to the vrealize Business installation files and double-click the ITBM-Installer_<BuildNumber>.jar file. 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. Evaluation Mode: This is the default mode. Licensed Mode: If you have the vrealize Business license, select the option and enter the license key 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 Upgrade Database Schema Create New Database Schema Description The installer uses upgrade scripts that are available with the installation files to upgrade the existing schema. a b Click Next. In the Database Schema Content Source window, select Default scripts that is included in the Installation environment. The installer uses scripts to create a new schema for upgrading the content of an external database. a b c d Click Next. In the Database Schema Content Source window, select Custom in the Installation environment. Click Next. 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. Evaluation Mode: This is the default mode. Licensed Mode: If you have the vrealize Business license, select the option and enter the license key in the text box. 9 Select Upgrade as the installation type. 10 Click Next. 34 VMware, Inc.

35 Chapter 3 Upgrading and Custom Installations 11 On the Database Schema page, create a new schema or upgrade an existing one. Option Upgrade Database Schema Create New Database Schema Description The installer uses upgrade scripts that are available with the installation files to upgrade the existing schema. a b Click Next. In the Database Schema Content Source window, select Default scripts that is included in the Installation environment. The installer uses scripts to create a new schema for upgrading the content of an external database. a b c d Click Next. In the Database Schema Content Source window, select Custom in the Installation environment. Click Next. In the Custom Dump File window, click Select File to select the custom dump file. Upgrade the vrealize Business Application To upgrade the vrealize Business system (.war file) only and import the data through the dump file. Prerequisites Remove any trailing backslash characters when setting the Server Instance. This is known to create installation difficulties during upgrades. From version 7.5 or later versions, shared dashboards are no longer supported. Any dashboards that exist in the My Reports hierarchy under the incoming shared reports folder will be deleted. To preserve shared dashboards, you must move them into the My Reports hierarchy by using either the Move menu option 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. From Version 7.5 onwards, Out-of-the-Box roles are overwritten during an upgrade. If changes are made to any of these roles, the administrator must update these roles manually after the upgrade. In general, if many changes are required to the Out-of-the-Box roles, create a copy of each role and maintain all modifications in the copied roles instead of the Out-of-the-Box roles. 1 Run the vrealize Business installer. System Windows Non-Windows Description Navigate to the vrealize Business installation files and double-click the ITBM-Installer_<BuildNumber>.jar file. 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. Evaluation Mode: This is the default mode. Licensed Mode: If you have the vrealize Business license, select the option and enter the license key in the text box. 4 Select Upgrade as the installation type. 5 Click Next. VMware, Inc. 35

36 vrealize Business Installation and Administration Guide 6 Select Do not build Data Schema as the Database Schema. Example: Upgrading the Application Only You have a development environment and a production environment that are both running the same version. If the development environment is upgraded to a later version of vrealize Business, modifications are 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 the production environment, and import the data from the dump file. Upgrade the Database To 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. 1 Run the vrealize Business installer. System Windows Non-Windows Description Navigate to the vrealize Business installation files and double-click the ITBM-Installer_<BuildNumber>.jar file. 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. Evaluation Mode: This is the default mode. Licensed Mode: If you have the vrealize Business license, select the option and enter the license key 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 Only You 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 to upgrade 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 18 onwards. NOTE The content packages and advanced settings screens are not available or applicable while upgrading the database. 36 VMware, Inc.

37 Chapter 3 Upgrading and Custom Installations Custom Installation Use the custom installation to change specific details in the installation. This installation option should be used 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 vrealize Business Application and Database, on page Run the vrealize Business installer. System Windows Non-Windows Description Navigate to the vrealize Business installation files and double-click the ITBM-Installer_<BuildNumber>.jar file. 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. Evaluation Mode: This is the default mode. Licensed Mode: If you have the vrealize Business license, select the option and enter the license key 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 compatible with the vrealize Business version that is being installed. This option is for expert users only and not recommended. Example: Situations that Require Custom Installation You 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 making other 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 18 onwards. VMware, Inc. 37

38 vrealize Business Installation and Administration Guide Update the Java Runtime Environment Version You can use the latest Java Runtime Environment (JRE), when supplied with win32 JRE (1.7.0_72) for Windows and Linux. 1 For Linux - In the file ITBM/Tomcat /bin/setenv.sh point the JAVA_HOME to the new location. For Windows - In the file ITBM/Tomcat /bin/setenv.bat point the JAVA_HOME to the new location. NOTE This should be the parent folder of the Java bin folder. 2 Restart the server. 3 Verify the JRE version. 38 VMware, Inc.

39 Configuration Files 4 The configuration files are used to configure the files used in vrealize Business. This chapter includes the following topics: Working with Configuration Files in vrealize Business, on page 39 ServiceFlow Properties, on page 39 About Flat Files, on page 39 Batch Whitelist Properties, on page 40 vrealize Business Key, on page 40 vrealize Business License, on page 41 Working with Configuration Files in vrealize Business If you are an advanced user of vrealize Business, such as an administrator, you can use the serviceflow.properties, flat_files.properties, batch_procedure_whitelist.properties, ITBM.key, and ITBM.license files to improve the system performance. ServiceFlow Properties vrealize Business administrators can use the serviceflow.properties file to configure the following system parameters: Infrastructure Configuration Parameters, on page 75 Dimensions Configuration Parameters, on page 77 Database-Related Configuration Parameters, on page 77 Engine-Related Configuration Parameters, on page 78 Security Configuration Parameters, on page 80 About Flat Files You can find a list of all the folders accessible for flat files adaptor. For security reasons, access to other directories on the server through vrealize Business is not allowed. Contains a list of folders accessible for flat files adaptor. Each folder is represented by a separate line. Rows beginning with # are considered comments and are ignored. VMware, Inc. 39

40 vrealize Business Installation and Administration Guide Empty lines are ignored. You can access them by using a path relative to the application instance directory or by using the absolute path. Exists in the.war file under default-config. Contains a single reference to the default adaptor_files folder. If a copy is placed in DF-Config, it extends the internal list. After you edit the file, you must refresh your cache. Batch Whitelist Properties This 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 an exception if you try to run them. The format is, each stored procedure is on a separate line, no commas are necessary. Rows beginning with # are considered comments and are ignored. Empty lines are ignored. You may add more procedures at the end. This file exists in the.war file under default-config. It contains a list of the default procedures. If a copy is placed in DF-Config, it will EXTEND the internal list. If you make a change to this file you must do Refresh Cache. Batch Whitelist Properties SF_ANALYZE_ADAPTORS SF_ANALYZE_FLOW SF_ANALYZE_FLOWS SF_ANALYZE_INDEX SF_ANALYZE_OPERATOR SF_ANALYZE_TABLE SF_CALC_LAST_COMPLIANCE_DATE SF_COMPACT_FLOW SF_COMPACT_FLOWS SF_COMPACT_FLOWS SF_COMPACT_OPERATOR SF_COMPACT_TABLE vrealize Business Key This 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 passwords stored in the database. 40 VMware, Inc.

41 Chapter 4 Configuration Files vrealize Business License Is the vrealize Business application license key which is provided by the user on the license key installation page or through Administration > Tools > General Preferences > Licensing page. Example ABCDE ABCDE VMware, Inc. 41

43 Post-Installation VMware, Inc. 43

45 Post Installation Tasks 5 To use and verify vrealize Business, you must perform certain configuration tasks after completing the installation. This chapter includes the following topics: Log In to vrealize Business, on page 45 Verify Basic vrealize Business Features, on page 46 Configure Settings, on page 46 Set the Time Zone, on page 47 Oracle Parameters Customized for vrealize Business, on page 47 Encrypting Passwords, on page 48 Enable Data Table Archiving, on page 49 Sending Traps with SNMP, on page 49 Enabling SSL for Tomcat, on page 50 Test the SSL Configuration, on page 51 Verifying Character Compatibility, on page 51 Supporting Lotus Notes, on page 52 Configure vrealize Business Cluster Installation, on page 52 Log In to vrealize Business To access the vrealize Business login with your vrealize Business user credentials. You can login to the application using a web browser. Prerequisites Install the vrealize Business on the server. 1 In your web browser, type the address in the following format: host is the name of the machine on which vrealize Business is installed. port is the port on which vrealize Business is running. NOTE To connect to the designer, type VMware, Inc. 45

46 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 the vrealize Business with the new user credentials. Verify Basic vrealize Business Features After you install vrealize Business, you must test the computing environment, regardless of the application server type. Prerequisites Log in to vrealize Business, create a user, and save the user settings. 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 Settings You can use vrealize Business option to send reports, send data for adjustment and approval and notify users about security breaches during user credential validation. 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 address, credentials for your system, and click OK. If you change 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. 46 VMware, Inc.

47 Chapter 5 Post Installation Tasks 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 has Only the list below option selected, it allows only certain sender addresses to send s. Set the Time Zone The vrealize Business receives input from many systems with potentially different time zones. You must configure 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 updated version. To view the updated instructions, go to Download the time zone update tool from NOTE For the most up-to-date time zone information for a Windows and Linux OS, you must stop any running instances of the JDK/JRE software to be operated before you run the TZUpdater tool on the installed JDK/JRE software image. 1 From the vrealize Business Administration page, select Tools > System Definitions > General Preferences > Options tab. 2 Set the time zone for your system using the Timezone drop-down menu. Oracle Parameters Customized for vrealize Business In vrealize Business, the DBA modifies the values of Oracle parameters used by the vrealize Business installations. The DBA also ensures that the session and process parameters correlate to the number of concurrent users present in the system. The vrealize Business does not require the Oracle Recycle Bin feature. Disable this feature if you want to run 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 verison of 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 SHARED_POOL_SIZE LOG_BUFFER Specifies the size of the DEFAULT buffer pool for buffers of the primary block size. Determines the size of SQL statement cache. This parameter is used to enable the reuse of statements. Determines the number of buffers, each the size of the system page, located in SGA as a result of the changed data written to the redo log files. Unset the parameter. Unset the parameter. Unset the parameter. VMware, Inc. 47

48 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 CURSOR_SHARING WORKAREA_SIZE_POLICY SESSION_CACHED_CURSORS PROCESSES SESSIONS JAVA_POOL_SIZE DB_WRITER_ PROCESSES PGA_AGGREGATE_ TARGET SGA_TARGET SGA_MAX_SIZE MEMORY_TARGET MEMORY_MAX_ TARGET Enables the Oracle Cost-Based Optimizer when statistics are available. Determines the type of SQL statements that can share the same cursors. Setting the value of this parameter to Exact allows only statements with identical text to share a cursor. Determines whether Oracle should automatically allocate in the PGA and SGA, or that these areas will be allocated manually. Specifies the number of cursors to cache per session. Specifies the maximum number of processes. Specifies the maximum number of sessions. The number of background database writer processes to start Target size for the aggregate Process Global Area memory consumed by the instance. ALL_ROWS Only the value Exact is supported and certified. AUTO Unset the parameter. 3 Unset the parameter. Unset the parameter. Unset the parameter. 5GB Unset the parameter. Encrypting Passwords You can encrypt the password when the vrealize Business stores the user and user passwords for RDBMS authentication. The password encryption is applicable for systems which use Tomcat as the Web server. Encrypt User Passwords You can encrypt user password for Tomcat systems when vrealize Business stores the user and user passwords for RDBMS authentication. 1 In the jserf.xml file, add the digest="sha" to the current definition of DataSourceRealm after the rolenamecol="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"/> 48 VMware, Inc.

49 Chapter 5 Post Installation Tasks 2 For user passwords, add the ENCRYPT_PASSWORD=true flag definition to DF Config/serviceflow.properties file. Encrypting Tomcat and LDAP Configuration Passwords You 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 Archiving vrealize Business can archive data tables in a second database schema called the Archiving Database schema. 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. 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 match the values in the archiving schema. 5 Restart the server. Sending Traps with SNMP The vrealize Business uses SNMP traps to recognize significant events by way of an unsolicited SNMP message. 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. The digitalfuel.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 trap watcher. VMware, Inc. 49

50 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 Tomcat You can configure SSL on your Tomcat application server to encrypt information. Prerequisites For information on uploading the SSL certificate, see Verify that the system administrator, or similar user, has installed the SSL certificate and provided the path to the key file and its password. If you are using a reverse proxy, set the EXTERNAL_SERVER_URL property in serviceflow.properties file. This property can be set during installation. 1 Set the SERVER_URL property in the serviceflow.properties file. a b Open DF-Config/serviceflow.properties. Update the SERVER_URL property to SERVER_URL= name:external port/jserf/. Use a fully-qualified domain name as the host name. The term localhost is not a valid host name when using SSL. If enabling SSL in a cluster environment, each node in the cluster should be able to access all other nodes by their host names. 2 Navigate to conf/server.xml and replace your current connection definition with the following definition 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 and authorization, in addition to the user authentication. 3 To deny hosts or allow only specific hosts, the system administrator should browse <Tomcat root>/<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 the following line (use the regular expressions to define ip addresses). <Valve classname="org.apache.catalina.valves.remoteaddrvalve" deny="" allow=""/> 50 VMware, Inc.

51 Chapter 5 Post Installation Tasks 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 Configuration After 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 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 Compatibility Operating systems must have language definitions that correspond to the language used in vrealize Business. Problems with character display might occur when you generate RTF files for export to Microsoft Word or Excel. Prerequisites Verify that the language definition in the operating system is correct. If you cannot change the language definition, use the following workaround. This is more common on UNIX systems. 1 Open the appropriate file for your application server. Table 5 2. Application Server Details Application Server File Tomcat Windows: ITBM\Tomcat \bin\catalina.bat 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>. VMware, Inc. 51

52 vrealize Business Installation and Administration Guide Supporting Lotus Notes When you send reports that contain images to Lotus Notes users, the default image type in vrealize Business (.png) cannot be viewed. The quality of the image differs with each image type. Additionally, the size of the is significantly affected by the image type value. 1 To set the type of images that are sent to Lotus Notes users, change CHART_IMAGE_TYPE_FOR_MAIL flag in DFL_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 to truncate the RPS_CACHE table. Configure vrealize Business Cluster Installation Several 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 in a cluster environment, on page 14. Prerequisites Install vrealize Business on a shared systems, such as a cluster configuration. 1 Configure session replication by updating the following properties. McastService - This is a multicast address that must be unique for each cluster. By default, the value is set to This is used for heartbeat node discovery. NioReceiver - This is the listening port and address of the node. For more information, see 2 Configure backend scheduling by updating the DF-Config/quartz.properties file. Set the org.quartz.jobstore.isclustered to True for cluster nodes to grab jobs and run at their own discretion. 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 all nodes and cached data. Set the SERVER_URL property in the DF-Config/serviceflow.properties file in all nodes to a URL that other cluster nodes can use to access the machine (IP address). 52 VMware, Inc.

53 Backup and Recovery 6 Backups are critically important in the maintenance of your vrealize Business database server. Backups help prevent 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 of lost files and configurations. The ideal backup strategy is to automate the backup process and minimize the manual actions performed by the system administrator. This chapter includes the following topics: Backup Strategies, on page 53 Oracle Database Backups, on page 54 Using or Linking Veritas NetBackup with vrealize Business, on page 54 Recovery, on page 54 Backup Strategies You need to take regular backups of file system and Oracle database. vrealize Business applications recommends its users to follow these Backup strategies: In addition to the manual backups that you perform as part of system upgrades or planned hardware and software maintenance, schedule regular file system and Oracle database backups. Back up your data to a secondary device, another server, tapes, or any other type of storage. Automate the backup process to maintain consistency. Back up your system during the night, when system usage is very low. Perform a full file system backup followed by incremental backups that back up changed files. This practice helps to do a quick system restore. 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 the saved database files are not being modified while they are being copied, and old database files that are no longer required on the disk can be removed after a successful backup image is made. If the old data is not removed, the disk can fill up quickly. VMware, Inc. 53

54 vrealize Business Installation and Administration Guide Oracle Database Backups The Oracle database contains most of the information that is used throughout the vrealize Business. To ensure that you can restore the database, perform a proper back up regularly. Database Backup Types The following Oracle database backups provide alternative methods of recovery. Full Database Backups - Full database backups are used to restore the Oracle database to any specific time, including the last time the database was operating normally. To use a full database backup for recovery, operate Oracle in archive mode so the archive logs are copied to a save area. To recover to a specific time, the last full backup files are loaded, then the archive log files are applied until the specific time is reached. If archive log files are not available, a cold full database backup can still be used to restore the database to the point when the cold full database backup was made, but changes made after that time cannot be recovered. Recovery using a hot full database backup cannot be accomplished unless all archive logs are available. Logical Oracle Database Backups - Logical Oracle database backups are used to recover to the time when the logical database backup was completed. The Oracle import tool is used to regenerate the database in case of major failures. This type of recovery is useful to restore the database to a past state where the database is known to be undamaged. If the database has been damaged in some manner so that it does not start up, then imports are not possible. In this case, the database must be rebuilt using a complex process available in the Oracle installer, or the database can be restored from the most current set 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 be copied to tape along with other disk files, and disk space is freed when old files are deleted after the successful file system backup. Your system administrator should ensure that the folder containing the archive logs, and the Oracle backup files are included in the file system backup. Using or Linking Veritas NetBackup with vrealize Business Recovery When you use the Veritas NetBackup product with vrealize Business, there is some confusion as to which datasets 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 regular basis by using an Oracle agent or library for Veritas. vrealize Business has no special requirements. The Veritas NetBackup RMAN Oracle library must be linked to the Oracle binary file. This linking does not affect the vrealize Business database schema. You can use a backup of your data files, control files, archive log files, and initialization parameters to recover a failed database. You might want to create a copy of the vrealize Business application on another system to aid in recovery. You can use the following recovery options for media failure. Recover database Recover datafile Recover tablespace 54 VMware, Inc.

55 Chapter 6 Backup and Recovery Perform a Generic Recovery You 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 initialization parameters. 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. VMware, Inc. 55

57 Planning Requirements for 7 vrealize Business As a user, you can use various techniques to estimate the disk space requirements of the vrealize Business application. With this option you can plan the future business needs of vrealize Business. This chapter includes the following topics: Factors Affecting the Disk Capacity Calculation, on page 57 Configuring the Database Disk, on page 58 RAID Devices, on page 59 Factors Affecting the Disk Capacity Calculation Various factors affect the disk capacity calculation of vrealize Business. You can identify the factors and take necessary action to enhance the performance of the vrealize Business application. The following factors affect the capacity calculation of vrealize Business: Number of operators in a flow Number of business rules defined for a flow Number of rows in an adaptor Complexity of the lines in an adaptor (number of bytes per line) Operator-specific factors such as configuration and additional attributes. Flow Size Calculation You 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 instance and 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

58 vrealize Business Installation and Administration Guide Table 7 1. Operators Affected by Flow Size Calculation Operator Aggregate Identify Description Aggregate functions in the flow s aggregate operators directly contribute to the Number Operators in the Flow value. If the flow contains one or more aggregate operators, count the number of aggregate functions in each aggregate operator. Add this number of functions to the number of other, non-aggregate operators. This total is the Number Operators in the Flow value. For example, say a flow has five operators and three of them are aggregate. Each aggregate operator has two aggregate functions, so the flow has six aggregate functions. The Number Operators in the Flow value in this case is eight, six for aggregate and two for the other two operators. If the flow contains the Identify operator, use this formula to determine the number to 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 a particular resource is mapped. If this ratio cannot be determined, use this formula to determine the Identify operator: (Number of Providers) * (Number of Customers) * (Number of Groups) Configuring the Database Disk To improve vrealize Business application performance you must select the appropriate file distribution and database disk configuration values. vrealize Business Data Storage Tablespaces vrealize Business data is stored in data files on the disk, which are grouped together into logical storage units called tablespaces. The Oracle database contains all the default tablespaces. The following table describes some of the data storage terms associated with the vrealize Business application. Table 7 2. Data Storage Terms Used in vrealize Business Data Storage Term System Undo Temp (or Temporary) Application tablespace Description Used for data dictionary objects such as tables, indexes, utilities, and packages. No objects must reside in this tablespace except for the Oracle metadata. Used for storing the undo data of committed transactions to enable the rollback of transactions. Used for holding temporary segments created by sort operations written to a disk. To improve performance, this tablespace is usually of a temporary type. No permanent objects can reside in this tablespace, and it must not reside on a RAID disk. Place the temporary tablespace data files on fast devices, which do not need to be large storage devices. One or more tablespaces used for storing tables and indexes. NOTE You must ensure that vrealize Business data and indexes are stored as separate entries. 58 VMware, Inc.

59 Chapter 7 Planning Requirements for vrealize Business vrealize Business Storage Workload Analysis Using the various logs and database control files you can understand the workload on the different storage devices used in vrealize Business. For example, the redo logs are considered hot I/O locations, because they consist of two or more preallocated files that store all changes made to the database as they occur. For this reason the redo logs are placed on a separate, exclusive, fast storage device. This practice prevents them from becoming the database bottleneck. The following table describes the definition of some of the database file disk distribution terms associated with the vrealize Business application. Table 7 3. Database File Disk Distribution Terms Used in vrealize Business Database File Disk Distribution Terms Redo log groups Database control files Description Use at least two groups with three files in each group. Place the groups on separate, individual disks for redundancy and performance. Separate the online redo logs disk from other database activity and from the archived redo logs. Place the redo logs on fast devices, which do not need to be large storage devices. Use at least three control files, located on different disks. RAID Devices The use of RAID devices is transparent to Oracle. All the features specific to RAID configurations are handled by the operating system and not Oracle. RAID Configuration The use of RAID devices differs according to the Oracle file type. Data files and archive logs can be placed on RAID devices because they are accessed randomly. Do not place redo logs on RAID devices because they are accessed sequentially and performance is enhanced by having the disk drive head near the last write location. Oracle recommends that you mirror redo files. RAID is easier to use than the Oracle techniques for data placement and striping. Keep in mind the following RAID configuration recommendations. RAID usually affects write operations more than read operations. This is especially true where parity needs to be calculated (RAID 3, RAID 5, and so on). You can place online or archived redo log files on RAID 1 devices. Do not use RAID 5. Place TEMP tablespace data files on RAID 1 devices, instead of RAID 5, because the streamed write performance of distributed parity (RAID 5) is not as good as that of simple mirroring (RAID 1). You can use swap space on RAID devices without affecting Oracle. Table 7 4. RAID devices RAID Type of RAID Control File Database File Redo log or Temporary Archive File 0 Striping Avoid OK Avoid Avoid 1 Shadowing OK OK Recommended Recommended 0+1 Striping +Shadowing OK Recommended Avoid Avoid VMware, Inc. 59

60 vrealize Business Installation and Administration Guide Table 7 4. RAID devices (Continued) RAID Type of RAID Control File Database File Redo log or Temporary Archive File 3 Striping with static parity OK Avoid when this data file involves heavy write operations Avoid Avoid 5 Striping with rotating parity OK Avoid when this data file involves heavy write operations Avoid Avoid RAID 0 does not provide protection against failures. RAID 0 requires a strong backup strategy. RAID 0+1 is recommended for database files because it avoids hot spots and provides the best possible performance during 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 following configurations to combine RAID 0 and RAID 1. RAID 0+1 is implemented as a mirrored array with segments that are RAID 0 arrays. 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 RAID 0 array. Advantages and Disadvantages of RAID Implementation Using 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 RAID to be used. Advantages of RAID RAID 1 is useful in systems where complete redundancy of data is necessary and disk space is readily available. With RAID1 the writes to the memory are much faster. Inclusion of RAID improves the system performance by distributing I/O load equally on several physical servers. RAID supports creation of logical files that are larger than the maximum size supported by the operating system. Disadvantages of RAID RAID 1 is not suited for systems with large data files and less disk space. Data striping might not allow you to locate single data file on specific physical drive. Some of the application tuning capabilities might be lost due to data striping. Data recovery becomes time consuming, as all the disks that are a part of the logical RAID device must be 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 that consecutive segments are stored on different physical storage devices. 60 VMware, Inc.

61 Creating RTF Templates 8 In the vrealize Business application, you can use the data tags and flow control tags from the dynamic tag library to customize the default system templates and create RTF templates for Word documents. These documents are distributed to customers and other vrealize Business users. This chapter includes the following topics: Dynamic Tag Library, on page 61 Agreement Documentation Tags, on page 62 Report Documentation Tags, on page 66 Advanced Options, on page 69 Troubleshooting the RTF Template, on page 70 Dynamic Tag Library The dynamic tag library is used by advanced vrealize Business system users to create RTF templates for agreement and report documents. Location of System Templates You can use tags to customize the default system templates in the DF-Config/presentation folder. Table 8 1. Default Templates Template slaoverview.rtf templateoverview.rtf report.rtf Description Used for exporting agreements to Word. Used for exporting master agreements to Word. Used for exporting reports to Word. In addition to default templates, you can use tags to create private templates for Export Using Layout and Booklet actions. About Dynamic Tags in vrealize Business The 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 bracket must be either a dollar sign ($) or a pound sign (#). Data Access VMware, Inc. 61

62 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 a reference to an object. This reference is also used to retrieve data from that object. The declaration statement uses the following format. <#set ($referencename = OBJECT_DECLARATION)> For more information, see Agreement Documentation Tags, on page 62 and Report Documentation Tags, on page 66. Flow Control The syntax for the basic flow control is: #CONTROL_COMMANDS (for example:foreach/if/end/set). Agreement Documentation Tags You can use the dynamic tag library to create agreement documents. The output documents contain several elements that are controlled by tags. The elements, agreements, revisions, categories, and business rules, are nested by dependent loops in that order. Agreements Agreements define the service agreement parameters between the serving system or staff, the provider, the recipient, and the customer. There can be multiple services, and therefore multiple agreements, for a relationship. The following example declares an agreement. <#set ($mysla = $slartffactory.sla( mysla ))> Table 8 2. Agreement Documentation Tags Documentation Tag $slartffactory.currentsla() $slartffactory.sla("your SLA Name") $slartffactory.sla("sla ID") $slartffactory.template("your Master Agreement Name") $slartffactory.template("master Agreement ID") Description Retrieves the agreement that is currently in the context. Use this tag for the Export to Word feature. Retrieves the agreement with the name Your SLA Name. Use this tag when documenting an agreement from the Booklet feature. Retrieve the agreement with the ID SLA ID. Use this tag when documenting an agreement from the Booklet feature. Retrieve the master agreement with the name Your Master Agreement Name. Use this tag when documenting an agreement from the Booklet feature. Retrieve the master agreement with the ID Master Agreement ID. Use this tag when documenting an agreement from the Booklet feature. NOTE If the name is not unique, an error message appears. If you receive an error message, the Master Agreement ID is used. 62 VMware, Inc.

63 Chapter 8 Creating RTF Templates You can concatenate the groupbycategory tag to the agreement declaration statement. Use it to divide the business rules into a group according to the system default category, usually Classification. The advantage is that you can process the business rules according to the groups. <#set ($mysla = $slartffactory.sla( mysla ).groupbycategory())> Property Tags The property tags are used in the PROPERTY_COMPONENT part of the basic access tag. In this list, mysla is used as a reference name, but any other name that is defined in the declaration can be used. Table 8 3. PROPERTY_COMPONENT Tags Property component $mysla.name $mysla.description $mysla.providername $mysla.customername $mysla.udfs $mysla.binarydtos <$mysla.groupbytype> <$mysla.revisions> <$mysla.revisions.size()> Description The name of the agreement. The description of the agreement. The provider name of the agreement. The customer name of the agreement. The level user defined field list. Agreement level user defined field list of type attachment If the value is 1, display a flat list of all the business rules in the revision. If the value is 2, display business rules directly under the revision under the General Terms And Conditions category. Business rules appear under services in a tree structure within the Services category. A list of Revisions. Number of revisions. The name of the field can be used for fields that are not predefined such as agreement fields in user defined fields. 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 Revisions Revisions contain the content of an agreement for a specified time. For example, one revision might span January to June and another, with different business rules, might span July to December. Revision Looping The revisions loop is nested under the main statement in the agreement documentation tag. This following example loop is for processing all the revisions. <#foreach ($revision in $mysla.revisions)> <#end> Property Tags The property tags are used in the PROPERTY_COMPONENT part of the basic access tag. VMware, Inc. 63

64 vrealize Business Installation and Administration Guide Table 8 4. PROPERTY_COMPONENT Tags Property Component <$revision.revisionnumber> <$revision.status> <$revision.startdate> <$revision.enddate> <$revision.description> <$revision.objectives> Description The number of the Revision. Possible values include: 1 - Active revision 2 - Pending revision 3 - History revision 4 - Draft revision 5 - Awaiting approval 6 - Revoked revision The values are used in an <#if>conditional tag. The start date of a Revision. The end date of a Revision. The description of a Revision. 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()> <$revision.groupbyservices> <$revision.groupbyservices.size()> <$revision.udfs> <$revision.binartdtos> A list of business rules that do not belong to a service. Relevant for cross-service business rules. A list of business rules under services. Relevant if $mysla.groupbytype == 2. A list of business rules that belong to a service, grouped by service. Revision level user defined fields. Revision level user defined fields list of type attachment. Categories A category is a type of business rule. vrealize Business includes general terms and conditions, business services and technical services, performance, financial, and specification categories. Category Looping The 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, the business rules are displayed under the category in which they reside. The general terms and conditions category for the business rules reside directly under the revision. The services category for the business rules reside in a tree-like structure. 64 VMware, Inc.

65 Chapter 8 Creating RTF Templates Business Rules A business rule is a tool that measures service performance. The business rule defines the agreement between parties and measures performance according to a defined breach condition. Business Rule Looping The business rule loop is nested under the revisions loop in the agreement documentation tag, or under the categories 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 <$objective.name> <$objective.statement> <$objective.metricname> <$objective.targets> <$objective.udfs> <$objective.binarydtos> Description The name of the business rule. The business rule statement. The name of the business rule template. A list of the business rule targets. The business rule level user defined fields. 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 the categories 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 <$target.type> <$target.value> Description The type of the business rule target. The value of the business rule target. Category Looping The category loop is nested under the revisions loop in the agreement documentation tag, or under the categories 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 <$objective.name> <$objective.statement> <$objective.metricname> <$objective.targets> <$objective.udfs> <$objective.binarydtos> Description Name of the business rule. Business rule statement. The name of the business rule template. List of the business rule targets. Business rule level user defined fields. Business rule level user defined fields list of type attachment. VMware, Inc. 65

66 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 <$component.type> Description Type of the component. type == 2. Service folder type == 1. Service type == 12. Service instance type == 6. Business rule If component.type == 6, then additional tags are uses for the components. Table 8 9. Component Type == 6 Tag <$component.name> <$component.statement> <$component.metricname> <$component.targets> <$component.udfs> <$component.binarydtos> Description Name of the business rule. Business rule statement. The name of the business rule template. List of the business rule targets. Business rule level user defined fields. Business rule level user defined fields list of type attachment. Report Documentation Tags You can use the dynamic tag library to create report documents. There are several elements, which are controlled by tags, in the output document. The elements, parent reports, child reports, and report filters are nested by dependent loops in that order. Parent Reports These reports are the main reports that are displayed when you use report documentation tags to present reports in output for the export to word or booklet features. If any drill down reports extend from the parent report, they appear as child reports in the output. Declare a Report This 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 booklet feature. 66 VMware, Inc.

67 Chapter 8 Creating RTF Templates Table Parameters for Report Documentation Tags Parameter Meaning Possible Values publishedreportnameorld Report name or ptree_base_id of the report Report name withreportstring Includes report in booklet True or False. withdrilldownsstring Includes one or more drilldowns 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 Tags The 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 the declaration can be used. Table Property Tags for Parent Reports Tag <$myreport.reporttitle> <$myreport.starttime> <$myreport.reportperiod> <$myreport.aggregationperiod> <$myreport.reports> <$myreport.specificreportname> <$myreport.reports.size()> Description The report title. The report start date. The report period. The report aggregation period. The report lists the actual reports. The report also contains child reports of composite reports or report plus its drilldowns. For more information see Child Reports, on page 68. The name of the specific report. This tag can be used only in the booklet and not in export to word. In the case of export to word, the field will be empty. Is the number of reports. For more information see Child Reports, on page 68. VMware, Inc. 67

68 vrealize Business Installation and Administration Guide Table Property Tags for Parent Reports (Continued) Tag <$myreport.reportduration> <$myreport.hasanydata> Description Calculates the values for displaying the report duration, as in current 12 Month (Jul 1, Jul 1, 2008). The true or false value indicates that there is a child report that does or does not contain data. This is useful for omitting reports from booklets that are empty. Child Reports Child reports present additional information that is not included in the parent reports. Child reports are reports that allow you to navigate through the parent reports. Report Looping Use a report loop to process multiple reports. This sample loop processes all of the reports. In case of a composite report, the report loop processes all displayed reports. In all other cases, this loop processes the main report and any drilldown reports. <#foreach ($report in $myreport.reports)><#end> Property Tags These property tags are used in the dynamic tag language to display elements in child reports Table Child Report Property Tags Tag <$report.reporttitle> <$report.reportdescription> <$report.starttime> <$report.reportperiod> <$report.context> <$report.aggregationperiod> <$report.sortedbydescription> <$report.reportbody> <$report.reportbody( width in pixels, height in pixels, pdf_shift )>> Description The report title. The description of the report. The report start time. The report period. BU or relationship context, if one exists. The report aggregation period. The description of the sorting for the report. The report body. All parameters are optional. However, you can use these parameters as follows: width and height values retrieve the report body with the specific size in pixels. The default values for width is 500 pixels and for height is 375 pixels. These parameters are relevant only for graphical reports and do not affect table reports. The pdf_shift parameter adds pixels before the report in a PDF output for display purposes. Its default value is 400 pixels. <$report.filterssummary> A list of filters. See Report Filters, on page 69. <$report.filterssummary.size()> <$report.hasdata> The number of filters. See Report Filters, on page 69. This true or false value indicates that this child report does or does not contain data. 68 VMware, Inc.

69 Chapter 8 Creating RTF Templates Report Filters Report 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 Report Filters Options Tag <$filter.title> <$filter.formattedfiltervalues> Description Filter title Filter values Advanced Options This option is used to modify standard dynamic tag library elements to improve the agreement or report output. Filters for Agreement Documentation Tags Agreement 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 filter statements. Table Filter Statements Filter Statement filterrevisions( filter string on the revision name ) currentrevision( ) filterslos( filter string on the Business Rule name ) filterbycategory( category value") Desciption Retrieves only the revisions whose names contain the parameter. Retrieves only the current revision of the agreement. Retrieves only the business rules whose names match the parameter. Retrieves only the business rules that have the value category in the system default category. They are usually Classification. Categories are metric fields. Concatenating Filters and Functions Different 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 is activated, only the last function is used. The following example retrieves the agreement with revisions that include interested revision in their names, with business rules that include interested business rule in their names, and access to the business rules grouped by the category in "my category". $slartffactory.sla( your Agreement name ) filterrevisions( interested revision ) filterslos( interested Business Rules ) groupbycategory( my category ) VMware, Inc. 69

70 vrealize Business Installation and Administration Guide Condition Tags This tag is used to exclude empty fields that not mandatory. For example, Description, are intentionally left blank. 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 Lists You can use the <$velocitycount> tag in every #foreach loop to get the index of current iteration, starting from one. The result is the number as a text field that can be placed anywhere in a sentence. This does not implement 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 a Microsoft Word numbering scheme. Troubleshooting the RTF Template You can troubleshoot problems with the dynamic tag library. Incorrect Syntax Incorrect 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 the template body text. If the #set command is wrong, all of the tags that use this reference are handled as part of the template body text. 70 VMware, Inc.

71 Chapter 8 Creating RTF Templates Solution There is no solution. No Data Available When 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 of empty string can be configured to other text in the EMPTY_FIELDS_VALUE_FOR_RTF_BOOKLET property in 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 Name If 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 agreement name 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. VMware, Inc. 71

73 Administration VMware, Inc. 73

75 Configuring vrealize Business 9 System Parameters If you are an advanced user of vrealize Business, such as an administrator, you can configure the infrastructure, dimensions, database, and engine parameters to improve the vrealize Business system performance. This chapter includes the following topics: Infrastructure Configuration Parameters, on page 75 Dimensions Configuration Parameters, on page 77 Database-Related Configuration Parameters, on page 77 Engine-Related Configuration Parameters, on page 78 Security Configuration Parameters, on page 80 Infrastructure Configuration Parameters You 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 True to encrypt the data source database password. IS_SCHEDULER 1 Set the IS_SCHEDULER to 1 to determine whether a node should run the schdueler. SCHEDULER_KEEP_ALIVE True Set SCHEDULER_KEEP_ALIVE to True to start the scheduler. PORTAL_HOMEPAGE_REPORT_ON_CLICK_ENABLED False Set PORTAL_HOMEPAGE_REPORT_ON_CLICK_ENA BLED to add the onclick code to the portal homepage report. PORTAL_HOMEPAGE_REPORT_ON_CLICK_ENABLED SERVER_URL /jserf/ Set this value to indicate which menu is available to set the portal report homepage. Set SERVER_URL to specify the vrealize Business Server URL. Bootstrap.setUrlPrefix function uses this to set this value. VMware, Inc. 75

76 vrealize Business Installation and Administration Guide Table 9 1. Infrastructure Configuration Parameters (Continued) Property Name Default Value Description EXTERNAL_SERVER_URL /jserf/ Set EXTERNAL_SERVER_URL to specify the URL that users use to access the vrealize Business. NOTE This address might be different than the SERVER_URL if the vrealize Business is fronted by a proxy. TRIGGER_POINTS_ON False Set TRIGGER_POINTS_ON to True to enable or disable trigger points control in the report header. LDAP_INTEGRATION_MODE False Set the LDAP_INTEGRATION_MODE to false to specify the user management screen LDAP integration. Use as specified in the deployed.war. MAX_OBJECTS_TO_LOAD 7000 Set the MAX_OBJECTS_TO_LOAD value to specify the import export dependency tree configuration. DRILL_DOWN_NAVIGATION_LINKS_ VISIBLE True Set the DRILL_DOWN_NAVIGATION_LINKS_ VISIBLE to true to specify the drilldown navigation links in the parent report. NUM_WORK_QUEUE_THREADS 50 Set the NUM_WORK_QUEUE_THREADS value to specify the number of worker threads for asynchronous processing, excluding precacher. REPORT_RUNTIME_CACHE_SIZE 15 Set the REPORT_RUNTIME_CACHE_SIZE value to specify the number of report headers that can be in the cache simultaneously. If the report headers are extremely large, you might need to decrease this value to prevent out-of-memory exceptions. COST_MODEL_UPLOAD_SHOW_END_TIME True Set COST_MODEL_UPLOAD_SHOW_END_TIME to True to allow mapping an END_TIME from the data. UI_HELP_INDEX_URL UI_HELP_CONTENT_URL Set UI_HELP_INDEX_URL value to view the index file of the user interface help menu. Set UI_HELP_CONTENT_URL value to view the content of the user interface help. UI_LOGOUT_ENABLED True Set UI_LOGOUT_ENABLED to True to enable the logout button. UI_LOGOUT_REDIRECT URL Set UI_LOGOUT_REDIRECT to redirect to a different URL after logout, this is is used for SSO logout. ENABLE_BREADCRUMB Edit the serviceflow.properties located under <ITBM_instance_folder>/DFconfig. Add ENABLE_BREADCRUMBS = true. Logout and re-login or refresh the browser. 76 VMware, Inc.

77 Chapter 9 Configuring vrealize Business System Parameters Dimensions Configuration Parameters You 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 to dimension nodes. These parameters are typically used for recursive dimension nodes such as Name Global. For example, the recursive node for dimension node USA is (USA Global). DIM_REC_TITLE_SUFFIX \Global) DIM_REAL_TITLE_PREFIX DIM_REAL_TITLE_SUFFIX LIVECHAT_ENABLED False Enables chat integration with LivePerson at LIVECHAT_SITE_ID LIVECHAT_IMAGE_URL LIVECHAT_REFERER_OVERRIDE LIVECHAT_EXTRA_PARAMS /Gallery/ChatButton- Gallery/English/General/1a Life chat site ID Image URL. This is the default. Override referer sent to live chat. If not set, the current URL is used. Pass extra values to LiveChat operator. The format is param=value. Several parameters might be defined, delimited by semicolons: param1=value; param2=value;... Database-Related Configuration Parameters You can use these properties to configure database-related parameters. Table 9 3. Database-Related Configuration Parameters Property Name Default Value Description QUERY_FACTORY_CLASS INDEX_TABLESPACE= TABLE_TABLESPACE= com.digifuel.serviceflow.infra.comm on.db.querybuilder.querycomponent Use Oracle defaults Do not modify this property. This parameter is used only if vrealize Businessruns on servers other than Oracle. Oracle stores tables in tablespaces. Each tablespace uses its own files on the server s disks. For better performance, keep tables and their indexes in separate tablespaces that are stored on different physical disks. These properties tell vrealize Business which tablespaces to use for tables and which to use for indexes. If these properties are not set, vrealize Business uses the Oracle defaults. VMware, Inc. 77

78 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 maximum number of extents to use for tables, after which tables cannot grow in size. ORACLE_ENTERPRISE_EDITION True If the database server is an Oracle enterprise edition, vrealize Business optimizes itself by using the enterprise features. DB_CONN_LOGIN_TIMEOUT 60 Specifies the timeout value for connections to the database. The administrator decides the value of this to be in seconds or milliseconds. If you encounter connection timeout problems, you can increase this value. Engine-Related Configuration Parameters You 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 STATISTICS_DURATION_OF_ RUNTIME_THRESHOLDS STATISTICS_MINIMUM_PERCENTAGE_THR ESHOLD ENGINE_JOB_STUCK_TIME FLOW_MANAGER_DATES_FORMAT 3600,7200, above black,orange,red. Seconds and colors map that defines the font colors of runtime values. 20,60,100 The thresholds, in percent, for runtime duration in flows. 60 On the flow/operator statistics page, the minimum runtime, in seconds, required for the UI to display the visual indicators of a significant percentage of runtime The time, in seconds, after which the job is considered stuck. Default is 12 hours, after the transaction should have 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, for queries to have their explain plan logged. LOG_FILE_HOURS_AHEAD 49 Flat file adaptor look ahead setting. IGNORE_NEW_LINE_TERMINATED True Determines whether the lines that do not end with an end-of-line are ignored in flat file adaptors. LOG_FILE_CHARSET Flat file adaptor charset. Possible values are UTF-8 or ISO VMware, Inc.

79 Chapter 9 Configuring vrealize Business System Parameters Table 9 4. Engine-Related Configuration Parameters (Continued) Property Name Default Value Description LOG_FILE_WILDCARD_BRACKETS_ CONSTANTS True Determines whether to treat brackets as constants in wildcard templates. Otherwise they are treated as defining a set of characters. Default is false. Examples: The template c:\logs\data[12345].csv matches if true: 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. String value, for example, GMT, America/New_York. ADAPTOR_DB_SYBASE_NO_NESTED_QUERY True Some early versions of Sybase do not allow nested queries. DO_NOT_ABORT_RUNNING_JOBS False Disable Abort Job feature. The Abort Job feature might not work with some drivers and databases, and might result in exceptions. Set this flag to true to bypass. DEFAULT_USE_FREEZE_DATE False Default of the use_freeze_date property of newly created flows. DEFAULT_USE_MANY_TRANS True Default of the use_many_trans property of newly created flows. RUN_DDL_MODE 0 Affects how DDLs are run. 0 for using Statement, 1 for using the safer Prepared Statement. BREACH_ADJUSTMENT_TIMEOUT 10 When adjusting a breach, the engine opens a new thread, and tries to adjust the breach dynamically. The user does not wait for this breach to be adjusted, but the thread does not try to adjust the breach for more than BREACH_ADJUSTMENT_TIMEOUT seconds. When the flow runs, all the adjustments that did not happen adjust. ENGINE_DEFAULT_RETRY_COUNT 1 Number of times to retry by default if a batch runs a job and fails. ENGINE_RESPAWN_COUNT 1 Number of times to retry if a batch tries to run a job, but the job does not start running. Minimum value = 1. ENGINE_RESPAWN_INTERVAL_SECS 1 Number of seconds to wait between retries 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 batch runs a job and the job fails. ENGINE_RESPAWN_COUNT 3 Number of times the system should respawn the job. VMware, Inc. 79

80 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 wait between respawn attempts if a batch to run another job, but that job does not start at all and the system tries to respawn it. DISABLE_FLOW_PARALLELISM False If true, then the FlowRunnerJet uses a regular connection instead of a parallel connection. MINOR_MUTEX_ABORT_TIME 30 Minimum time to wait for the Minor Mutex Abort feature. If set to 0, feature is disabled. Security Configuration Parameters You can use these parameters to define the behaviour of the application if you enter values for fields which are case sensitive. You can also decide whether to add security filters to a user, based on their role. You can use 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 helps you to solve the authenticationauthorization case mismatch problems. If this property is set, users always create, import, and log in using lower case letters. SECURE_HEADER_FILTERS True Information revealed in reports is primarily determined by the user s role. In general, filtered information is not role-dependent. This property controls whether to add security to the filters. ENCRYPT_TC_ENV True Determines whether to keep Tomcat data source password and LDAP credentials encrypted. 80 VMware, Inc.

81 Troubleshooting vrealize Business 10 This section provides information about the problems that you might encounter when using vrealize Business and provides possible solutions. This chapter includes the following topics: User Cannot Access vrealize Business Application, on page 81 Adaptors Fail when You Import Data from an SQL Table, on page 82 No Data in Database Adaptor for a Non-Oracle Server, on page 82 Flow Calculations are not Visible, on page 82 No Data Passes through the Identify Operator, on page 83 Unable to View Existing Reports, on page 83 Not Receiving for Report Distributions, on page 83 Unable to Send to Lotus Notes Users, on page 84 Unable to Synchronize LDAP and Active Directory Users, on page 84 Failed to Create a Document, on page 85 User Cannot Access vrealize Business Application User 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 the vrealize 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

82 vrealize Business Installation and Administration Guide Adaptors Fail when You Import Data from an SQL Table Adaptors 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 table or field name for an SQL database. Use double quotation marks ( " " ) around the table or field for an Oracle database. No Data in Database Adaptor for a Non-Oracle Server User 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 install the correct JDBC driver that matches your database. Table JDBC Driver Option Tomcat Description ${instance_path}/../lib Flow Calculations are not Visible You 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 your flow. Solution Select Data Processing > Flow Manager and navigate to the appropriate flow. 82 VMware, Inc.

83 Chapter 10 Troubleshooting vrealize Business No Data Passes through the Identify Operator If you create a flow with an identify operator, no data passes through the identify operator, hence no breaches are generated. Problem When you create a flow with an Identify operator and activate the job for it, data does not pass through the identify operator and no breaches are generated Cause Undefined resources, incorrect resource mapping, and mapping dates that do not include dates of the data might cause this problem. Solution 1 Ensure that you define the resources at the designer and verify that the resources were defined exactly as they appear in the data, including spaces. 2 Ensure that the resource mapping is correct. When you map the resource, ensure that the mapping dates include the date of the data, even if that date is in the past. Unable to View Existing Reports When 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 for Report Distributions You do not receive s for defined report distributions. Problem You are unable to receive s notifications for alerts or report distributions that should be sent on set schedules. 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 s from being sent. For example, the SMTP allows only certain sender addresses to send s. VMware, Inc. 83

84 vrealize Business Installation and Administration Guide Unable to Send to Lotus Notes Users You are unable to send s to Lotus Notes users. Problem Lotus Notes does not support HTML anchors in s. Cause This limitation might result in a problem when you send a report that contains links in an to Lotus Notes users. Solution vrealize Businessincludes a workaround to remove the links between a report and its drilldowns. 1 Add the LOTUS_NOTES_COMPATIBILITY flag to the serviceflow.properties file. 2 Set the value to either True or False. Table LOTUS_NOTES_COMPATIBILITY Table Value True False Behavior Links do not work in any application. This is true for table and graphical reports. Use this option when recipients use Lotus Notes. Do not remove the links. Links work in applications except for Lotus Notes. Unable to Synchronize LDAP and Active Directory Users Synchronization 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, these error messages appear in the log file. Failed to connect to set up the CTX 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. 84 VMware, Inc.

85 Chapter 10 Troubleshooting vrealize Business Failed to Create a Document When 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 following error message: Failed to create document. (code 3209). Solution u If you see Failed to create document. (code 3209), set the SERVER_URL property in the serviceflow.properties file. VMware, Inc. 85

87 Index A activation 29 adaptors fail 82 administrator 25 Advanced Options 69 Advanced Settings 27 advantages of RAID 60 Agreement DocumentsAgreement Documents 62 Agreement Documentation Tags 69 Agreements 62 Application tablespace 58 applications 19 auditing reports 26 authentication 23, 30 B backend scheduling 52 backup and recovery 53 Batch Whitelist Properties 40 business rules 57 Business Rules 65 business rulesbusiness rules 62 C cache management 52 Capacity Factors 57 Categories 64 Category Looping 64 Character compatibility 51 Child Reports 68 cluster 14 cluster configuration 14, 52 common 26 Concatenating Filters 69 Concatenating Functions 69 Condition Tags 70 configuration 45 Configuration Files 39 configuring 7 configuring vrealize Business system parameters 75 content packages 26, 27 content source 18 cost model 31 Counter for Lists 70 Create RTF Templates 61 creating 12, 13 custom 19 custom installation 33, 37 custom package 26 customer 20 D data validation 26 Data Access 61 Data Storage 58 Data tags 61 database 11, 18 database administrator 12 database parameters 22 database adaptor 82 database instance 22 database schema 18 database-related configuration Parameters 77 Dimensions Configuration Parameters 77 disadvantages of RAID 60 disk space 57 Documentation TagsDocumentation Tags 62 dump file 19 Dynamic Tag Library 61 Dynamic Tags 61 E elements 62 settings 46 Enable data table archiving 49 Encrypting user passwords 48 Engine-Related Configuration Parameters 78 environment variables 11 Export to Word 61 F fail over 14 failed to create document 85 file system backups 53 Flat file properties 39 flow calculations 82 VMware, Inc. 87

88 vrealize Business Installation and Administration Guide Flow Control 61 flow control tags 61 flow size calculation 57 G Generic recovery 55 groupbytype 64 guide 7 H host 22 https parameters 22 I identify operator, no data 83 import data 82 Incorrect Syntax 70 infrastructure configuration parameters 75 installation mode 17 Installation s 19 Installation Summary 29 installation type 17 Installation Checks 29 installing 7, 9, 16 integration 29 IT Financial Manager 19 J Java Runtime Environmenet 38 jdbc connection 82 K key 40 L LDAP LDAP connection 24 license 41 LINUX configuration 13 load balancer 14 Log In 45 Lotus notes 52 Lotus Notes users 84 M mail 28 mail distributor 28 manage budget 31 mapping file 30 Master Agreement ID 62 media failure scenarios 54 modify OOTB 31 N no data 71 No Name or No Unique Name 71 not receive s 83 O objects 27 Oracle database 12 oracle parameters 11 Oracle parameters 11 Oracle user 13 Oracle database backups 53, 54 oracle users 11 P Parent Reports 66 password encryption 40 Password encryption 48 performance 12 Planning requirements 57 portfolio 19, 26 Post installation tests 46 post-installation 7 Property Tags 68 PROPERTY_COMPONENT PROPERTY_COMPONENT 63 R RAID Configuration 59 RAID devices 59 RDBMS 23 Recommended Backup Strategy 53 Recovery 54 Redo log groups, Database control files 59 Report Documentation Tags 66 Report filters 69 report.rtf 61 reports 27 Revision Looping Revision Looping 63 revisions 62 Revisions Revisions 63 roles 26 RTF Template 70 S Security Parameters 80 server parameters 21 ServiceFlow Properties 39 session replication 52 set time zone 47 setting 47 Setting Oracle parameters VMware, Inc.

89 Index SLA 19 SLA ID 62 SLA Name 62 SLA Manager 26 slaoverview.rtf 61 slartffactory.currentsla() 62 SNMP Traps 49 SQL scripts 26 SSL configuration 50 SSL Configuration 51 SSO 23 standard roles 26 Start server 29 Synchronization for LDAP and Active Directory 84 synchronizing users, synchronizing groups 25 System 58 system global area, process global area 11 System Templates 61 system types 20 workload analysis 59 T tablespaces 12 templateoverview.rtf 61 test tomcat 51 time zone 47 token 30 Tomcat 21 Tomcat and LDAP configuration passwords 49 troubleshooting 81 troubleshooting workaround 81 U unable to access vrealize Business 81 Unable to View Reports 83 UNIX configuration 13 update 38 upgrade 33 upgrade application 33, 35 upgrade database 33, 36 upgrade and custom installation 33 upgrade application and database 33 upgrade schema 19 upgrading 9 users 23, 25 V verify installation 45 Veritas NetBackup 54 W WAR file 26 VMware, Inc. 89