ConfigSnapshot Installation Guide 4.1

5/26/2018 ConfigSnapshot Installation Guide 4.1

1/30

ConfigSnapshot

Step-By-Step Installation and Set Up

Document Control: Rookery SoftwareVersion: 4.1.0


2/30

ConfigSnapshot Installation Guide 4.1.doc -i-

Company ConfidentialRookery Software / 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.2.3 Working With Oracle OLE DB .............................................................................. 6

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


3/30

ConfigSnapshot Installation Guide 4.1.doc -1-


1 Prerequisites

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

Oracle Client this must be the 32 bit version of the Oracle Client regardless of the version ofWindows you are using

o Oracle Net

Microsoft Office (Word and Excel)

In addition if you are using either Setup Migration or File System Report you must install in the Oracle Client:

Oracle Objects for OLE

Oracle Provider for OLE DB

Oracle Net What is it?

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

OLE DB What is it?

Enables OLE DB-compliant applications to access the Oracle database.

N.B.Oracle OLE DB is installed as a COM object in Windows. This means that only one version is ever

installed at one time regardless of the number of Oracle Homes installed. The version currently in use will bethe most recently installed.

If you dont have an appropriate Oracle Client see details inAppendix 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 usedbut is not required. See instructions inCreating Read Only Accessabout how to create a new readonly user (this will need to be performed as a one-off activity by someone with SYSTEM accesspermissions)

2 Installation

Download the following fromhttp://www.configsnapshot.net/configsnapshot_download_area.html :

ConfigSnapshot x.y

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

Unzip the file ConfigSnapshot_x-y.zip

Run setup.exe

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

N.B. If you are upgrading from ConfigSnapshot 2.x or 3.x this will be treated as a new installation. The

previous version of ConfigSnapshot will be uninstalled and 4.x will then be installed.
http://www.configsnapshot.net/configsnapshot_download_area.htmlhttp://www.configsnapshot.net/configsnapshot_download_area.htmlhttp://www.configsnapshot.net/configsnapshot_download_area.htmlhttp://www.configsnapshot.net/configsnapshot_download_area.html


4/30



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


5/30



Choose Next.

Choose Install.

Choose Finish.

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


6/30



3 UpgradesIf you already have ConfigSnapshot 4.x.x installed and you are applying a later update (e.g. 4.1.0) theprocess 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.


7/30



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)

N.B. It is highly recommended that if you are working with R12.2 of the E-Business Suite that you use anOracle ODBC driver and not the Microsoft for Oracle ODBC driver as Oracle has replaced all LONG columnsby CLOB columns; CLOB columns cannot be used with the Microsoft for Oracle ODBC driver.

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 driverprovided 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 providedbased on the TNSNAMES.ora file from the same Oracle Home. If the environment is not listed it has notbeen correctly added to the correct TNSNAMES.ora file. Please note that you must use the 32 bit version of

the ODBC driver if your version of Windows is 64 bit (C:Windows>SysWow64>odbcad32.exe) with the 32 bitversion of the Oracle clientfurther details in section 4.3 below.

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 OracleHome. This may not be the expected home so should be checked and, where necessary, the system shouldbe 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 configuredthrough the selector.

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

Choose the WindowsStartoption

Choose Run

Type cmd

Choose OK

Type path and pressenter

Check the valuedisplayed for the Pathvariable. Look for the firstOracle Home in the Path

variable. This will be thedefault Oracle Home.


8/30



In the screen above the default Oracle Home is C:\oracle\product\10.2.0\client_3\bin. The location for theTNSNAMES.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, youmust 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 Variablessection, select the Pathvariable and choose Edit

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

Choose OKon each form until you return to the Control Panel

4.2.3 Working With Oracle OLE DB

Another consideration when working with multiple homes is when you are using OLE DB (for Setup Migrationand File System reporting). Unlike many other aspects of the Oracle Client, OLE DB is installed as a COMobject in Windows so only one version will be installed at any time. Any time it is installed into an OracleClient it will override any previous version that has been installed. Therefore, the TNSNAMES.ora that workswith OLE DB could be in a different Oracle Home than the data sources you have defined.


9/30



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

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

64-bit Windows Operating Systems

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

Although you will most likely find the Data Sources (ODBC)option in the Control Panelthis should NOTbeused to configure your data source. The version of the ODBC Administrator available through this route isthe 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 thisdirectory you will find a file odbcad32.exe. Double click this file and the 32-bit version of the ODBC DataSource Administrator will start up.

N.B. On Windows 64-bit machines there is also find a file called odbcad32.exe in theC:\WINDOWS\system32 directory. However, although it may be counter-intuitive, this is actually the 64-bitversion 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 fromthe Control Panel it is recommended a short cut is added to the C:\Windows\SysWoW64\odbcad32.exe fileon the desktop.

4.3.2 Creating a Data Source

Select either the User DSN or System DSN

(recommended where possible) tab and chooseAdd.

Any data sources created on the User DSN tabwill only be available to the current Windows user.

Any data sources created on the System DSN

tab will be available for all users.


10/30



Select the appropriate ODBC driver (either Microsoftfor 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 theenvironment.

The Descriptionand User Namefields 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 youchoose the data source in ConfigSnapshot.

Description will be the default name for the environment. Where no Description is specified the defaultname 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 themachine on which the environment is installed. See below for an example.

Choose OK.


11/30



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

The Descriptionand User IDfields can be left blank if required.

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


12/30



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

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

Ensure the Enable Query Timeoutoption is unchecked.

Select the Workaroundstab.

Ensure the DisableMicrosoftTransaction Serveroption is checked.

Ensure the ForceRetrieval of Longs ischecked, if shown.

Choose OK.


13/30



5 Using ConfigSnapshot

5.1 Starting ConfigSnapshot

Once you have successfully installed ConfigSnapshot and set up Oracle Net and an ODBC data source forat 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. Aftera few seconds you will be presented with a screen showing which modules/options have been successfullyactivated.


14/30



If any modules/options have failed to activate these will be shown in a second screen. In this case pleasesend details [email protected] 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 useConfigSnapshot it is recommended that you review the User Preferences and set these where appropriate toenhance 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 structuresrather than repeatedly reading from the database. These temporary XML structures must be storedsomewhereand 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 currentoutput 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 amajor effect on performance if the temporary XML is not managed locally to where ConfigSnapshot isinstalled.

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

The directory can be anywhere on your local directory structure. You can create it using Windows Explorer orfrom ConfigSnapshots User Preferences option. The directory name is not restricted but it is recommendedusing a name similar to ConfigSnapshot Temporary XML.

To set your temporary XML directory choose User Preferencesfrom the main ConfigSnapshot form. Thenselect the Directoriestab.
mailto:[email protected]:[email protected]:[email protected]:[email protected]


15/30



Choose the Browse button adjacent to the Temporary XML field and navigate to the directory you havecreated, or choose the Make New Folderoption 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.


16/30



6 Creating Read Only Access

6.1 Overview

ConfigSnapshot can configure user privileges to quickly enable the creation of one or more database userswith read only access. This is best achieved through the creation of a database role that can be granted toone or more users. The database role has select privilege on the objects necessary to run ConfigSnapshotreports 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 theConfigSnapshot role.

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

Create Session

Alter Session

Create database user

Creating a New Read-Only ConfigSnapshot User

Choose Administration

then select the Database

Roles option

Select Create Database

User

Choose Data Source forthe environment. Enter

SYSTEM password.

Choose Connect.

Enter Username and

Password for the new

user

Select a DefaultTablespace ** for the User

and the Temporary

Tablespace.

Create read only

privileges (role)

Grant ConfigSnapshot role

to database user



Roles option

Select RunConfigSnapshot Report

Role

Select Create Grants

Using ConfigSnapshot

Choose Data Source for

the environment. EnterSYSTEMpassword.

Choose Connect.



Roles option

Select Grant role to User

Choose Data Source forthe environment. Enter

SYSTEM password.

Choose Connect.

Enter user name to make

grant to and TAB.

Select

CSSHT_CSS_REPORT_

ROLE (Run

ConfigSnapshot Reports)

Enter APPSpassword.

Choose Connect.

Choose Grant RoleChoose OK

When prompted during

the process choose OKor

YES.

**As the user will not have any

privileges to create database objects

the choice of Default Tablespace isnot critical


17/30



6.2 Creating a Database User

To use ConfigSnapshot to create a database user:


Choose Database Roles Choose Create Database User

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


18/30



Enter the Username and Password to identify the database user. Choose the Default and TemporaryTablespacesfor this user.

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

Choose OK.

ConfigSnapshot will confirm creation of the new user.


19/30



6.3 Creating Read Only Privileges

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


Choose Database Roles

Choose Run ConfigSnapshot Report Role

Choose Yesto 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 andAPPS 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 privilegesto select the required object, usually either SYSTEM or APPS.

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

Once the process has completed the role can be granted to one or more database users or thescript 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 orthis can be done via ConfigSnapshot. To use ConfigSnapshot to grant the role:


Choose Database Roles

Choose Grant Role to User

Connect as the SYSTEM user to the environment


20/30



Enter the Usernamethat 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.


21/30



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 Allplease note that ConfigSnapshot is a 32 bitapplication hence needing this version of the Oracle Client even on Windows 64 bit machines.

Choose and download win32_11gR2_client.zip
http://www.oracle.com/technetwork/database/enterprise-edition/downloads/index.htmlhttp://www.oracle.com/technetwork/database/enterprise-edition/downloads/index.htmlhttp://www.oracle.com/technetwork/database/enterprise-edition/downloads/index.html


22/30



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

Oracle 10g Client

Choose Next.

Select Custom. Choose Next.


23/30



Enter details or accept the defaults. Choose Next.

Select SQL*Plus, Oracle Windows Interfacesand Oracle Net. If required, select Oracle Objects for OLEand Oracle Provider for OLE DB.

Choose Next.


24/30




25/30



Choose Next.

Choose Install.


26/30



Use the Configuration Assistantor manually configure your connections.


27/30



Choose Exit.

Oracle 11g Client

Select Custom. Choose Next.


28/30



Select the required languages for your installation. Choose Next.

Choose a location for the installation. Choose Next.


29/30



Select SQL Plus, Oracle Net and Oracle ODBC Driver. If required, select Oracle Objects for OLEandOracle Provider for OLE DB.

Choose Next.

Choose Finish.


30/30



Choose Close.

ConfigSnapshot Installation Guide 4.1

Documents

Transcript of ConfigSnapshot Installation Guide 4.1