Config Snapshot Installation Guide 3.3

2e2 UK Ltd: The Mansion House, Benham Valence, Speen, Newbury, Berks, RG20 8LU. Registered in England Number 4090390.

ConfigSnapshot

Step-By-Step Installation and Set Up

Document Control: 2e2 Business Applications Version: 3.3.0

ConfigSnapshot Installation Guide 3.3.doc -i-

Company Confidential – 2e2 / Client Use Only

Contents

1 PREREQUISITES ....................................................................................................1

2 INSTALLATION .......................................................................................................1

3 UPGRADES.............................................................................................................4

4 SETTING UP CONFIGSNAPSHOT .........................................................................5

4.1 Overview..........................................................................................................5

4.2 Multiple Oracle Homes.....................................................................................5 4.2.1 Working with an Oracle ODBC Driver..................................................................5 4.2.2 Working with the Microsoft for Oracle ODBC Driver............................................5

4.3 Configuring an ODBC Data Source..................................................................7 4.3.1 Starting the ODBC Data Source Administrator....................................................7 4.3.2 Creating a Data Source .......................................................................................7 4.3.3 Configuring Microsoft ODBC for Oracle Data Sources........................................8 4.3.4 Configuring Oracle ODBC Data Sources.............................................................9

5 USING CONFIGSNAPSHOT .................................................................................11

5.1 Starting ConfigSnapshot ................................................................................11

5.2 Activation .......................................................................................................11

5.3 Configuring ConfigSnapshot...........................................................................12

6 CREATING READ ONLY ACCESS .......................................................................14

6.1 Overview........................................................................................................14

6.2 Creating a Database User..............................................................................15

6.3 Creating Read Only Privileges .......................................................................17

6.4 Granting the ConfigSnapshot Role to Database Users...................................17

APPENDIX A..............................................................................................................19

Downloading the Oracle Client ...............................................................................19

Installing the Oracle Client......................................................................................20

ConfigSnapshot Installation Guide 3.3.doc -1-


1 Prerequisites Prior to running ConfigSnapshot the following must be installed on the client machine:

• Oracle Client / Oracle Net – this must be the 32 bit version of the Oracle Client regardless of the version of Windows you are using

• Microsoft Office (Word and Excel)

Oracle Net – What is it?

Oracle Net is Oracle's client/server middleware product that offers transparent connection from client tools to the database, or from one database to another.

If you don’t have Oracle Net see details in Appendix A

You will also require the following to install and start using ConfigSnapshot:

• Access to install software on your PC (local administrator rights are required during installation but administrator rights are not required to use the application)

• Access to configure ODBC drivers on your PC

• Valid TNSNames entries for the environments / instances you wish to run ConfigSnapshot against

• Valid database username and password to access the data (read only); the APPS user can be used but is not required. See instructions in Creating Read Only Access about how to create a new read only user (this will need to be performed as a one-off activity by someone with SYSTEM access permissions)

2 Installation Download the following from http://bacchus.hamilton.co.uk:

• ConfigSnapshot V3.2

The same file can be used to install ConfigSnapshot on a new machine or to upgrade an existing ConfigSnapshot installation to the latest version.

• Unzip the file ConfigSnapshot 3.2.zip

• Run setup.exe

If this is a new installation of ConfigSnapshot you will see the following series of screens during the installation process.

N.B. If you are upgrading from ConfigSnapshot 2.x this will be treated as a new installation. The previous version of ConfigSnapshot will be uninstalled and 3.x will then be installed.



Choose Next.

Check the option I accept the terms in the license agreement. Choose Next.



Ensure your User Name is not blank. If it is, enter the username you logged on to Windows with. Choose Next.

Choose Next.

Choose Install.

Choose Finish.

N.B. Depending on the components installed you may be prompted to restart your computer.



3 Upgrades If you already have ConfigSnapshot 3.x.x installed and you are applying a later update (e.g. 3.2.3) the process will recognise the current installation and simply upgrade to the latest version. The following screens will be shown during this process.

Choose Update.

Choose Finish.



4 Setting Up ConfigSnapshot

4.1 Overview

Prior to running ConfigSnapshot the following must be completed:

• Oracle client (32 bit version) installed on the computer

• Oracle Net configured for the environment(s)

o Do this using Net Configuration Assistant or directly modifying the TNSNAMES.ora file

• ODBC Data Source created for environment(s)

4.2 Multiple Oracle Homes

If you have multiple Oracle Homes on your machine, ensure the correct TNSNAMES.ora file is updated. Depending on whether you are planning to use the Microsoft for Oracle ODBC driver or an ODBC driver provided for Oracle this section explains the process to ensure the correct TNSNAMES.ora is used.

4.2.1 Working with an Oracle ODBC Driver

If using an Oracle ODBC driver, it will depend on which Oracle Home the ODBC driver was installed into. When configuring an ODBC data source using the driver a list of available connections will be provided based on the TNSNAMES.ora file from the same Oracle Home. If the environment is not listed it has not been correctly added to the correct TNSNAMES.ora file.

4.2.2 Working with the Microsoft for Oracle ODBC Driver

The Microsoft driver does not understand the concept of multiple homes, so it will use the default Oracle Home. This may not be the expected home so should be checked and, where necessary, the system should be changed to ensure that the required Oracle Home is set to be the default.

If you have the Oracle Home Selector installed, the default Oracle Home can be checked and configured through the selector.

In many cases the selector is not installed, so another method must be used to check the default home. The quickest way to do this is via a Command window:

• Choose the Windows Start option

• Choose Run…

• Type cmd

• Choose OK

• In the Command window, type path and press enter

• Check the value displayed for the Path variable. Look for the first Oracle Home in the Path variable. This will be the default Oracle Home.

In the screen to the right the default Oracle Home is C:\oracle\product\10.2.0\client_3\bin. The location for the TNSNAMES.ora file for this home will be C:\oracle\product\ 10.2.0\client_3\network\admin.



If the first Oracle Home is not a valid Home or is not the Home that you wish to use for ConfigSnapshot, you must modify the Path variable so that the correct Home is the first one listed. To change the Path variable:

• Open the Control Panel

• Choose System

• Click the Advanced tab

• Click Environment Variables

• In the System Variables section, select the Path variable and choose Edit

• Cut and paste the full Oracle Home directory and move it to the start of the variable definition.

• Choose OK on each form until you return to the Control Panel



4.3 Configuring an ODBC Data Source

4.3.1 Starting the ODBC Data Source Administrator

32-bit Windows Operating Systems

For 32-bit Windows operating systems this can usually be done as follows:

• Open Control Panel

• Choose Administrative Tools > Data Sources (ODBC)

For XP this can be found in the Performance and Maintenance option.

If the Administrative Tools or Data Sources (ODBC) option is not available it may have been disabled for your user. In this case use Windows Explorer to navigate to C:\windows\system32. In this directory you should find a file odbcad32.exe. Double click this file and the ODBC Data Source Administrator should start up.

64-bit Windows Operating Systems

With 64-bit versions of Windows there are often two versions of different components to enable both 64-bit and 32-bit applications to work. This can cause some confusion as it is essential that the 32-bit version of the component is used against 32-bit applications such as ConfigSnapshot.

Although you will most likely find the Data Sources (ODBC) option in the Control Panel this should NOT be used to configure your data source. The version of the ODBC Administrator available through this route is the 64-bit version of the application and any data sources will not work with 32-bit applications.

To create your data source, use Windows Explorer to navigate to C:\Windows\SysWoW64. In this directory you will find a file odbcad32.exe. Double click this file and the 32-bit version of the ODBC Data Source Administrator will start up.

N.B. On Windows 64-bit machines there is also find a file called odbcad32.exe in the C:\WINDOWS\system32 directory. However, although it may be counter-intuitive, this is actually the 64-bit version of the application and should not be used.

TIP: As the 32-bit version of the ODBC Data Source Administrator is not the default version available from the Control Panel it is recommended a short cut is added to the C:\Windows\SysWoW64\odbcad32.exe file on the desktop.

4.3.2 Creating a Data Source

Select either the User DSN or System DSN (recommended where possible) tab and choose Add.

Any data sources created on the User DSN tab will only be available to the current Windows user. Any data sources created on the System DSN tab will be available for all users.



Select the appropriate ODBC driver (either Microsoft for Oracle or Oracle) and choose Finish.

4.3.3 Configuring Microsoft ODBC for Oracle Data Sources

The Data Source Name is the name you will refer to in ConfigSnapshot when connecting to the environment.

The Description and User Name fields can be left blank if required.

If you enter a User Name this will be the default database user to connect to the environment when you choose the data source in ConfigSnapshot.

Description will be the default name for the environment. Where no Description is specified the default name for the environment will be Data Source Name.

Server must be set to the TNS Service Name for the environment. N.B. This is NOT the name of the machine on which the environment is installed. See below for an example.

Choose OK.



4.3.4 Configuring Oracle ODBC Data Sources

For Oracle ODBC data sources the look may vary slightly depending on the version of the driver being used:

The Data Source Name is the name you will refer to in ConfigSnapshot when connecting to the environment.

The Description and User ID fields can be left blank if required.

If you enter a User ID this will be the default database user to connect to the environment when you choose the Data Source in ConfigSnapshot.



Description will be the default name for the environment. Where no Description is specified the default name for the environment will be the Data Source Name.

TNS Service Name must be set to the TNS Service Name for the environment. This should have a drop down list making it easier to ensure that the service name has been correctly set up.

Ensure the Enable Query Timeout option is unchecked.

Select the Workarounds tab.

Ensure the Disable Microsoft Transaction Server option is checked.

Ensure the Force Retrieval of Longs is checked, if shown.

Choose OK.



5 Using ConfigSnapshot

5.1 Starting ConfigSnapshot

Once you have successfully installed ConfigSnapshot and set up Oracle Net and an ODBC data source for at least one environment you can start using ConfigSnapshot.

Double click the ConfigSnapshot icon on your desktop.

You will be presented with an activation screen, showing you when the trial version will expire.

To use the application during the trial period choose Continue Trial.

During the trial period only Financials > General Ledger is available.

5.2 Activation

If you have been sent activation codes for ConfigSnapshot choose License ConfigSnapshot.

You can enter activation codes individually but it is simpler to apply the XML file provided with all activation codes for licensed modules. Choose Activate Using XML File. Select the XML file you were provided. After a few seconds you will be presented with a screen showing which modules/options have been successfully activated.



If any modules/options have failed to activate these will be shown in a second screen. In this case please send details to [email protected] and we will ensure these are resolved.

5.3 Configuring ConfigSnapshot

To begin using ConfigSnapshot there is very little configuration that must be done. However, as you use ConfigSnapshot it is recommended that you review the User Preferences and set these where appropriate to enhance your usage.

When you first start ConfigSnapshot you may receive the following message:

To minimise the load on the database ConfigSnapshot does a lot of its work using temporary XML structures rather than repeatedly reading from the database. These temporary XML structures must be stored somewhere – and will be automatically deleted when they are no longer required.

If you do not specify a specific location to store the temporary files then ConfigSnapshot will use your current output directory. If this is a directory local to where ConfigSnapshot is installed then there will be no noticeable change to performance. However, if you are outputting to a network location there could be a major effect on performance if the temporary XML is not managed locally to where ConfigSnapshot is installed.

Therefore, ConfigSnapshot checks to see whether you have specified a location for the temporary XML files and warns you if no location has been set. You can continue without setting a location but it is highly recommended you set a local directory.

The directory can be anywhere on your local directory structure. You can create it using Windows Explorer or from ConfigSnapshot’s User Preferences option. The directory name is not restricted but it is recommended using a name similar to ‘ConfigSnapshot Temporary XML’.

To set your temporary XML directory choose User Preferences from the main ConfigSnapshot form. Then select the Directories tab.



Choose the Browse button adjacent to the Temporary XML field and navigate to the directory you have created, or choose the Make New Folder option if you have not yet created your directory.

Once you have selected the directory choose Save.

When you restart ConfigSnapshot you should no longer receive the warning message.



6 Creating Read Only Access

6.1 Overview

ConfigSnapshot can configure user privileges to quickly enable the creation of one or more database users with read only access. This is best achieved through the creation of a database role that can be granted to one or more users. The database role has select privilege on the objects necessary to run ConfigSnapshot reports and execute privilege on any standard Oracle functions required to access some data elements. None of the standard Oracle functions used updates the underlying database.

The database users can be created directly in ConfigSnapshot or existing users can be granted the ConfigSnapshot role.

If existing users are being used they must have the following privileges:

• Create Session

• Alter Session

In addition, certain functions will be quicker if they have the following privilege:

• Select on sys.dba_role_privs



6.2 Creating a Database User

To use ConfigSnapshot to create a database user:

• Choose Administration

• Choose Manage Database Roles

• Choose Create Database User

• Connect as the SYSTEM user to the environment on which you wish to create the user



Enter the Username and Password to identify the database user. Choose the Default and Temporary Tablespaces for this user.

N.B. ConfigSnapshot does not create any objects for this user.

Choose OK.

ConfigSnapshot will confirm creation of the new user.



6.3 Creating Read Only Privileges

To create the database role (CSSHT_CSS_REPORT_ROLE) and grant it the necessary privileges to run standard ConfigSnapshot reports:



• Choose Run ConfigSnapshot Report Role

• Choose ‘Yes’ to have ConfigSnapshot create the role and make the necessary grants. Choose ‘No’ for ConfigSnapshot to create a script that can be subsequently run against the environment.

• If you have chosen for ConfigSnapshot to create the role and grants, connect as both SYSTEM and APPS to the environment. ConfigSnapshot will then create the role and grants.

• If you have chosen for ConfigSnapshot to create a script, connect as a user with sufficient privileges to select the required object, usually either SYSTEM or APPS.

• ConfigSnapshot will then process the environment to identify the required objects. In a small number of cases the user will be prompted to confirm whether they wish to grant Select on a table or view to the role.

• Once the process has completed the role can be granted to one or more database users – or the script created can be run by a DBA

6.4 Granting the ConfigSnapshot Role to Database Users

The ConfigSnapshot role (CSSHT_CSS_REPORT_ROLE) can be manually granted to database users or this can be done via ConfigSnapshot. To use ConfigSnapshot to grant the role:



• Choose Grant Role to User

• Connect as the SYSTEM user to the environment



Enter the Username that the role is to be granted to. The available ConfigSnapshot Roles will be populated. Select the correct role – CSSHT_CSS_REPORT_ROLE (Run ConfigSnapshot Reports) and choose Grant Role.



Appendix A

Downloading the Oracle Client To download the SQL.Net for 32 or 64 bit Windows 7, see details below: http://www.oracle.com/technetwork/database/enterprise-edition/downloads/index.html Choose 11.x.x.x.x Microsoft Windows (32-bit) > See All – please note that ConfigSnapshot is a 32 bit application hence needing this version of the Oracle Client even on Windows 64 bit machines.

Choose and download win32_11gR2_client.zip



Installing the Oracle Client The requirements for installing the Oracle Client may depend on your specific needs but this section provides details of the components recommended for ConfigSnapshot installs.

Oracle 10g Client

Choose Next.

Select Custom. Choose Next.



Enter details or accept the defaults. Choose Next.

Select SQL*Plus, Oracle Windows Interfaces and Oracle Net. Choose Next.





Choose Next.

Choose Install.



Use the Configuration Assistant or manually configure your connections.



Choose Exit.

Oracle 11g Client

Select Custom. Choose Next.



Select the required languages for your installation. Choose Next.

Choose a location for the installation. Choose Next.



Select SQL Plus, Oracle Net and Oracle ODBC Driver. Choose Next.

Choose Finish.



Choose Close.

Config Snapshot Installation Guide 3.3

Documents

temporary

multiple oracle

oracle odbc

oracle data

odbc data

run configsnapshot

data sources

default oracle