www.configsnapshot.

com

ConfigSnapshot
Installation Guide

Document Control: Rookery Software

Version: 4.8
Date: DEC-2022
Contents

1 WHAT YOU WILL NEED ......................................................................................... 1

2 INSTALLATION ....................................................................................................... 1
3 SETTING UP CONFIGSNAPSHOT ......................................................................... 4
3.1 Overview .......................................................................................................... 4
3.1.1 Oracle Client Installation ...................................................................................... 4
3.1.2 Working with an Oracle ODBC Driver .................................................................. 4
3.2 Configuring an ODBC Data Source .................................................................. 5
3.2.1 Starting the ODBC Data Source Administrator .................................................... 5
3.2.2 Creating a Data Source ....................................................................................... 5
4 USING CONFIGSNAPSHOT ................................................................................... 7
4.1 Starting ConfigSnapshot .................................................................................. 7
4.2 Activation ......................................................................................................... 8
4.3 Configuring ConfigSnapshot............................................................................. 9
5 CREATING READ ONLY ACCESS (DBA TASK) ................................................. 10
5.1 Overview ........................................................................................................ 10
5.2 Creating a Database User .............................................................................. 11
5.3 Creating Read Only Privileges ....................................................................... 13
5.4 Granting the ConfigSnapshot Role to Database Users ................................... 13
APPENDIX A .............................................................................................................. 15
Downloading the Oracle Client ............................................................................... 15
Installing the Oracle Client ...................................................................................... 15

ConfigSnapshot Installation Guide 4.8.docx -i-

Company Confidential – Rookery Software / Client Use Only
1 What You Will Need
For the basic installation of ConfigSnapshot you will need the following:
• Latest ConfigSnapshot software from the ConfigSnapshot website
• Microsoft Windows operating system (on a PC, Windows Server or VM)
• Local administration access to the device the installation is being carried out on
• 32 bit Oracle client with correct components installed
• 32 bit ODBC driver
• TNSnames entries for any E-Business Suite environments you wish to run reports etc against.
• Microsoft Word, Excel and Microsoft Edge
• Database Username and password for each E-Business Suite environment

2 Installation
Download the current version of ConfigSnapshot from (password protected, see Rookery Software for
details) https://www.configsnapshot.com/Customer/EBS/SoftwareDownload:
• ConfigSnapshot x.y

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_x-y.zip
• Run setup.exe

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

Choose Next.

ConfigSnapshot Installation Guide 4.8.docx -1-

Company Confidential – Rookery Software / Client Use Only
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.

ConfigSnapshot Installation Guide 4.8.docx -2-

Company Confidential – Rookery Software / Client Use Only
Choose Install.

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

ConfigSnapshot Installation Guide 4.8.docx -3-

Company Confidential – Rookery Software / Client Use Only
3 Setting Up ConfigSnapshot
3.1 Overview
Prior to running ConfigSnapshot the following must be completed:
• Oracle client (32 bit version) installed on the computer
• Oracle ODBC Data Source created for environment(s)

3.1.1 Oracle Client Installation

Even if your PC is 64 bit you must still use the 32 bit Oracle client. Having multiple Oracle clients on a PC
should not be an issue so if you don’t already have an Oracle client or your existing one is 64 bit please
follow the steps in Appendix A to install the 32 bit client with the required components.
If your PC is 32 bit then any current Oracle Homes will be 32 bit.
If unsure of the version of any existing clients or if you have multiple clients and need to determine if any of
them are 32 bit the easiest way to check is via the registry:

If you do not have an entry in the

Computer\HKEY_LOCAL_MACHINE\SOFTWARE\Wow6432Node\ORACLE directory as shown above it
indicates that you do not have a 32 bit version of the Oracle client. If you do have an entry, click on it to see
where that client is installed. In the example above it can be found in C:\Oracle\product\11.2.0\client_1.

3.1.2 Working with an Oracle ODBC Driver

When 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. Or in correct character in the TNSnames file

ConfigSnapshot Installation Guide 4.8.docx -4-

Company Confidential – Rookery Software / Client Use Only
3.2 Configuring an ODBC Data Source
3.2.1 Starting the ODBC Data Source Administrator

64-bit Windows Operating Systems

Use Windows File 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 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.

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

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

ConfigSnapshot Installation Guide 4.8.docx -5-

Company Confidential – Rookery Software / Client Use Only
In the example above the Oracle Driver required is ‘Oracle in OraClient 19Home 1_32bit’. You must have the
TNSNames file in this Oracle Client. The location of the client can be found via the Registry Editor:
Computer\HKEY_LOCAL_MACHINE\SOFTWARE\WOW6432Node\ORACLE. In this directory you should
see your Oracle Client in the ORACLE_HOME_NAME and the location of this client in the ORACLE_HOME.
In this example, the TNSNAMES file must located in C:\Oracle\product\19.0.0\client_1\Network\Admin

Select the appropriate Oracle ODBC driver and choose Finish.

ConfigSnapshot Installation Guide 4.8.docx -6-

Company Confidential – Rookery Software / Client Use Only
For Oracle ODBC data sources the look may vary slightly depending on the version of the driver being used:

If a pick list is not available in the TNS Service Name field, type the name in manually.

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 may have a drop down
list making it easier to ensure that the service name has been correctly setup.
Ensure the Enable Query Timeout option is unchecked.
Click on the ‘Test Connection’ button then enter the database user name and password to check if the
connection works.

4 Using ConfigSnapshot
4.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.

ConfigSnapshot Installation Guide 4.8.docx -7-

Company Confidential – Rookery Software / Client Use Only
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.

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

ConfigSnapshot Installation Guide 4.8.docx -8-

Company Confidential – Rookery Software / Client Use Only
If any modules/options have failed to activate these will be shown in a second screen. In this case please
send details to support@rookerysoftware.com and we will ensure these are resolved.

4.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. Please see the Quick Start Guide for recommended user preference settings.

ConfigSnapshot Installation Guide 4.8.docx -9-

Company Confidential – Rookery Software / Client Use Only
5 Creating Read Only Access (DBA Task)
5.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

Creating a New Read-Only ConfigSnapshot User

Create read only Grant ConfigSnapshot role

Create database user
privileges (role) to database user

Choose ‘Administration’ Choose ‘Administration’ Choose ‘Administration’

then select the ‘Database then select the ‘Database then select the ‘Database
Roles’ option Roles’ option Roles’ option

Select ‘Run
Select ‘Create Database
ConfigSnapshot Report Select ‘Grant role to User’
User’
Role’

Choose Data Source for Choose Data Source for

the environment. Enter the environment. Enter
SYSTEM password. Select ‘Create Grants SYSTEM password.
Choose Connect. Using ConfigSnapshot’ Choose Connect.

Enter Username and

Choose Data Source for Enter user name to make
Password for the new
the environment. Enter grant to and TAB.
user
SYSTEM password.
Choose Connect.

Select a Default
Select
Tablespace ** for the User
Enter APPS password. CSSHT_CSS_REPORT_
and the Temporary
Choose Connect. ROLE (Run
Tablespace.
ConfigSnapshot Reports)

When prompted during

Choose OK the process choose OK or Choose ‘Grant Role’
YES.

** As the user will not have any

privileges to create database objects
the choice of Default Tablespace is
not critical

ConfigSnapshot Installation Guide 4.8.docx -10-

Company Confidential – Rookery Software / Client Use Only
5.2 Creating a Database User
To use ConfigSnapshot to create a database user:
• Choose Administration
• Choose Database Roles
• Choose Create Database User
• Connect as the SYSTEM user to the environment on which you wish to create the user

ConfigSnapshot Installation Guide 4.8.docx -11-

Company Confidential – Rookery Software / Client Use Only
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.

ConfigSnapshot Installation Guide 4.8.docx -12-

Company Confidential – Rookery Software / Client Use Only
5.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 Administration
• Choose Database Roles
• 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

5.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 Administration
• Choose Database Roles
• Choose Grant Role to User
• Connect as the SYSTEM user to the environment

ConfigSnapshot Installation Guide 4.8.docx -13-

Company Confidential – Rookery Software / Client Use Only
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.

ConfigSnapshot Installation Guide 4.8.docx -14-

Company Confidential – Rookery Software / Client Use Only
Appendix A
Downloading the Oracle Client
If you do not have an existing 32 bit version of the Oracle client please follow the steps below to install the
relevant details needed:

https://www.oracle.com/database/technologies/oracle19c-windows-downloads.html

Choose Oracle Database 19c Client (19.3) for Microsoft Windows (32-bit). Please note that ConfigSnapshot
is a 32 bit application hence needing this version of the Oracle Client even on Windows 64 bit machines.
Download the NT_193000_client.zip file as shown below. Please note, this is a very large file.

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 19c Client

Within the downloaded zip file (NT_193000_client.zip) double click on the setup.exe file, there then may be a
delay of a minute or so before a command window opens. This will then close down have done some basic
checks.

You should then see the form below where you should select the ‘Custom’ option

ConfigSnapshot Installation Guide 4.8.docx -15-

Company Confidential – Rookery Software / Client Use Only
Select user (must not have Admin access, in which case you could use the Built-in Account)

ConfigSnapshot Installation Guide 4.8.docx -16-

Company Confidential – Rookery Software / Client Use Only
Select Custom. Choose Next.

ConfigSnapshot Installation Guide 4.8.docx -17-

Company Confidential – Rookery Software / Client Use Only
Choose a location for the installation. Choose Next.

Select SQL Plus, Oracle Net and Oracle ODBC Driver and Oracle Provider for OLE DB.
Choose Next

ConfigSnapshot Installation Guide 4.8.docx -18-

Company Confidential – Rookery Software / Client Use Only
Choose Close.

You must now add the tnsnames.ora file to the appropriate directory. Find the new client and navigate to
Product > 19.0.0 > Client_1>Network>Admin:

Then add the ODBC connections per the instructions in section 3.2.

ConfigSnapshot Installation Guide 4.8.docx -19-

Company Confidential – Rookery Software / Client Use Only