Avocet Installation Reference

Contents
Installation Reference Guide.........................................................................................3
Purpose of this document.............................................................................................................................4
Prerequisite knowledge.................................................................................................................................4
Getting Started..............................................................................................................................................5
Understanding the processes.......................................................................................................................5
Setting up the configuration environment.....................................................................................................6
What is the configuration environment?........................................................................................................6
Locating the necessary files for a local installation.......................................................................................6
Setting up the database................................................................................................................................6
Choosing a database technology.................................................................................................................6
Setting up a new database schema on Microsoft SQL Server.....................................................................6
Guidelines for Oracle database 12c (12.1.0.2) setup ................................................................................13
Configure MS SQL Server reporting services............................................................................................23
Configure a database instance without initializing the application Id..........................................................24
Create a fresh database.............................................................................................................................24
Add an application Id..................................................................................................................................24
Configure the database..............................................................................................................................26
Launching the application and choosing login and system implementation options...................................26
Launching Avocet.......................................................................................................................................27
Selecting a culture during login...................................................................................................................28
Setting up a licensing path..........................................................................................................................28
Applying color codes to identify the source of data....................................................................................29
Displaying and storing datetime values (local time zone or UTC)..............................................................31
Avocet upgrade scenarios...........................................................................................................................34
About the Avocet 2008.1 SP1 upgrade.......................................................................................................35
Upgrade workflow example.........................................................................................................................49
Database upgrade from Avocet 2012.1 or Avocet 2012.1 SP 1 .................................................................58
Configuration updates for manual upgrades...............................................................................................61

ii Avocet Installation Reference

Installation Reference Guide
Avocet, the production operations software platform, encompasses functionality geared to managing
and utilizing production data and information to collect, report, compute, and analyze operational
activity.
This data assists oil and gas customers to
• safely operate oil and gas assets
• report to authorities and partners
• use the information to perform surveillance and diagnosis
• ultimately optimize production with operational constraints
• Engineered for operations, these systems assist the core business of any oil and gas company as
they deal with the company’s ultimate business goal – to produce more hydrocarbons, efficiently and
cheaper.
A tailored Avocet solution can provide:
• Monitoring, reporting and analysis of asset level parameters including surface equipment (separation
systems; gas, oil and water treatment systems; compressors and pumping equipment), measurement
systems (liquid, gas, and multiphase measurements), oil storage units, and subsurface equipment
• Allocating and reporting of measured fluids back to the producing wells that typically have only
estimated production, to build a volume management or a production data management system
• Monitoring, reporting, and analysis of production parameters and artificial lift equipment at the well
level
• Monitoring, reporting, and analysis for executing specific well-related services including well testing,
diagnostic interventions, and well improvement interventions (perforating, hydraulic fracturing, matrix
acidizing, and sand control services)
• Assurance that equipment and wells are operating at safe conditions to prevent accidents and failures,
thus preventing regulatory violations from occurring, including those related to chemical usage and
toxic emissions
An Avocet solution allows building of a modern flexible and functional foundation for the digital oilfield.
The solution is designed on modern Microsoft technologies and is designed to be flexible, configurable,
and localizable. The enterprise scalable architecture allows flexible configuration, tailoring of system
to operational needs, and the ability to grow as the enterprise grows to manage various operational
settings.
Avocet provides the following three main functions:
• Information collection – automated retrieval from SCADA/DCS, data historians, and third-party
systems as well as manual data capture using desktop, field laptop, and handhelds
• Processing – capability to verify the validity of collected information to generate computed results
for allocations, production processes, and operational surveillance
• Information distribution through integration – distribution of processed production information to
company personnel, partners, and government bodies in the form of reports and graphs. This
production information can be used within monitoring, surveillance, engineering design, facilities,
and reservoir optimization applications.

3
Purpose of this document
This document is designed to be a reference guide that supports the installation and deployment of
Avocet 2017.2. Use this document to supplement the Avocet Production Data Management System
Installation Guide .

Prerequisite knowledge
This topic discusses the database technologies and operating platforms knowledge needed to install
and deploy Avocet.
Readers of this document must be familiar with the following database technologies and operating
platforms.
• Microsoft Windows 7 or Microsoft Windows 10 desktop operating systems
• Microsoft Windows 2008, Microsoft Windows 2012, or Microsoft Windows 2014 server operating
systems
• Web portal technology with Internet Information Services (IIS)
• Oracle RDBMS and/or Microsoft SQL Server database technologies and associated tools and utilities
for executing SQL statements
• SQLite, but only for use with disconnected field laptops

4 Avocet Installation Reference

Getting Started
This sections describes the installation process for configuring the environment and deploying Avocet
company-wide, and the upgrade path based on the version of Avocet installed at your site.

Understanding the processes

This topic describes the installation process for configuring the environment and deploying Avocet
company-wide.

1. Preparing the configuration environment: A configuration environment allows you to set up

Avocet, install the database, and configure the application according to your needs. A configuration
environment can be an assigned test workstation. The configuration process consists of:
• Setting up the configuration environment
• Setting up the database
• Initializing the database
• Setting up licensing
• Launching and configuring the application

2. Performing a company-wide deployment: A production environment holds a tested configuration

of the production data management system. Using Microsoft ClickOnce technology, you can deploy
self-updating versions of Avocet to end-user workstations.You can choose to perform company-wide
deployment by using Microsoft ClickOnce or by copying the files from the configuration environment
manually to each workstation in the production environment.
• Creating a Microsoft ClickOnce deployment pack
• Setting up the production environment
• Installing the application on end-user workstations

Refer to the Avocet Production Data Management System Installation Help topic for specific
procedures.

5
Setting up the configuration environment
This section discusses the configuration environment, lists the tasks to perform during the configuration
process, and shows where to locate the installation files for a local installation.

What is the configuration environment?

A configuration environment is a computer (a desktop, workstation, or laptop) that is used to set up
the Avocet configuration. This topic lists the tasks to perform during the configuration process.
During configuration you perform the following tasks:
• Set up the database
• Install the Avocet database objects
• Configure and customize Avocet to your needs
• Set up a Microsoft ClickOnce deployment
• Publish the files from the test configuration environment to the production environment
Refer to the Avocet Production Data Management System Installation Help topic for specific procedures.

Locating the necessary files for a local installation

Your installation file set, on CD media or at a file download location, may be provided to you by an
SIS representative. Or you can download it from the Schlumberger Integrated Solutions Software
Download Center using the link in this topic.
The Schlumberger Integrated Solutions Software Download Center is located at
https://www.sdc.oilfield.slb.com/SIS/Login.aspx .

Setting up the database

This section explains the different database technologies supported and how to set up Microsoft SQL
Server and Oracle databases.

Choosing a database technology

This topic discusses which database technologies from which to choose.
You can set up an Avocet database using one of the following database technologies:
• Oracle RDBMS 12c database, Enterprise edition
• Microsoft SQL Server 2008 R2, 2012, or 2014 database
We recommend that you choose either Microsoft SQL Server 2016 or Oracle 12C.
The following sections describe the steps to prepare your chosen database technology before you set
up the Avocet database.

Note: SQLite support is aimed at single users of field laptops that are disconnected from
application servers.

Setting up a new database schema on Microsoft SQL Server

This section discusses what to do before you begin and shows an example of how to setup a new
database.

6 Avocet Installation Reference

 Note: This walkthrough uses MS SQL Server 2012 as an example. The steps for MS SQL
Server 2008 R2 and SQL Server 2014 are similar.

To install these database technologies, follow the instructions provided in their respective product
manuals or on their websites. Apply the latest patch.You can obtain the latest patch from the Microsoft
support website for your SQL server version.
If unsure of your database configuration, consult with a certified database administrator.
Before proceeding, ensure that the database server and tools are installed.

Set up a new database schema on Microsoft SQL Server

This task shows how to set up a new database schema on Microsoft SQL Server.

1. Click Start, and then choose SQL Server Management Studio to display the Connect to Server
dialog.
2. Select a server and provide system administrator (sa) credentials.

3. Click Connect to launch SQL Server Management Studio.

The Object Explorer opens by default. If not, open it using View > Object Explorer.
4. In the Object Explorer, right-click Databases and select New Database.
The New Database window opens.
5. In the Database name field, enter the name of the database instance you are creating. For example,
Avocet_Example.

7
 Note: Creating a database on your system drive (C:\) can result in data storage issues.
Instead, create a directory on your non-system drive (D:\). Change the path of the file types
Rows and Log to the file path of the directory.

6. From the tree, select Options.

7. In the Collation field, select SQL_Latin1_General_CP1_CS_AS.

8 Avocet Installation Reference

 A collation encodes the rules governing the proper use of characters for either a language, such
as Greek or Polish, or an alphabet, such as Latin1_General. A SQL Server collation defines how
the database engine stores and operates on character and Unicode data.
The case sensitive (CS) option is recommended for the Avocet database if you intend to use it
without integrating with other applications, such as Schlumberger Oilfield Manager (OFM) or Studio,
that are case insensitive (CI). However, if you intend to integrate with either, set your collation to
CI.
After data has been moved into an application, character sorts and comparisons done in the
application are controlled by the Windows locale selected on the computer. The collation used for
character data by applications is one of the items controlled by the Windows locale (a locale also
defines other items, such as number, time, date, and currency formats).
8. Click OK.
Microsoft SQL Server creates the database.

Create a functional account user (MS SQL Server)

This task shows how to create functional account users for Avocet.

1. In the Object Explorer, expand the Security folder to display the subfolders.

9
 2. Right-click the Logins folder to display the flyout menu, and choose New Login… to display the
Login – New window.
3. In the Login – New window, create a SQL Server authentication login name and password.
4. Uncheck the Enforce password policy, Enforce password expiration, and User must change
password at next login check boxes.
5. Click OK.
6. In the Object Explorer, open the Logins folder, right-click the login name, and choose Properties
from the flyout menu.

7. Under the Select a page heading, choose User Mapping to display the user mapping table and
database roles.
8. Map the Avocet user to the Avocet database, and assign the db_datareader and
db_datawriterpermission to the user.

10 Avocet Installation Reference

9. Click OK.
You include the functional account in the Avocet connection string.

Add an Active Directory user (Microsoft SQL Server)

The Active Directory user must already be defined in your Avocet user directory before you can map
him or her to the Avocet database. Refer to the Security Help topic for more information.

1. In theObject Explore of Microsoft SQL Server Management Studio, expand the Security folder
to display the subfolders.
2. Right-click the Logins folder to display the flyout menu, and choose New Login… to display the
Login - New window .
3. In theLogin - New window, select Windows authentication for the Login name selection, and
click Search… .

The Select User or Group dialog is displayed.

11
 4. Verify that the From this location field displays either your company's domain controller server or
Entire Directory.
• If the entry is correct, go to step 6.
• If not, click Locations... to open theLocations dialog.

5. Select Entire Directory, and click OK to return to the Select User or Group dialog.
6. In the Enter the object name to select text field, enter the name of the Active Directory user, and
click OK.

12 Avocet Installation Reference

 The Login - New window is displayed. The Active Directory user is displayed in the Login Name
field.
7. Under Select a page, choose User Mapping.
8. In the Users mapping to this login table, select the database to which the Active Directory user
is assigned. In the Database role membership for list, only assign the role db_datareader and
db_datawriter to the Active Directory user.
The administrator (admin user) needs the additional role db_owner to perform upgrades .

Do not assign the server role sysadmin. It is not necessary for the Avocet application.
9. Click OK to complete the Active Directory assignment.

Guidelines for Oracle database 12c (12.1.0.2) setup

This section outlines the main procedures in setting up the Oracle client database 12c and preparing
it for an Avocet implementation.
These guidelines cover the following topics:

13
 • Create a database instance in Oracle
• Create an Oracle listener
• Edit the tnsnames.ora, sqlnet.ora, and listener.ora files
• Create VM_DATA and VM_INDEX tablespaces
• Create Oracle user
• Configure firewall
• Check the Oracle database connection

Create a database instance in Oracle

You can use the Oracle Database Configuration Assistant to create your database.

1. In your Oracle installation, launch the Database Configuration Assistant wizard as an administrator.
2. In the Database Configuration Assistant - Welcome window, choose the Database Operation >
Creation Mode, and select Create Database, and click Next.
The Create Database window is displayed.
3. Under Prerequisite Checks, select the Create a database with default configuration option, and
complete the following fields:
Field Description

Global Database Name Enter the name you want to assign to the database.

Storage Choose File System (the default selection).

Database Files Location Accept the default {ORACLE_BASE}\oradata.

Fast Recovery Area Accept the default {ORACLE_BASE}\fast_recovery_area.

Database character set Accept the default value.

Administrative Password Enter your password and confirm it.

Create As Container Database Uncheck this option.

4. Click Next to continue to the Create Database - Summary window.

5. Verify the details, and click Finish.
The Progress Page of the Create Database installation window is displayed. When the installation
completes, the last window of the wizard is displayed.
6. At the Finish page, click Close to exit the wizard.

Create an Oracle listener

You create an Oracle listener through the Oracle Net Manager utility or the Net Configuration Assistant
wizard.

1. Launch the Net Manager utility as an administrator.

The Oracle Net Manager Oracle Net Configuration window opens.
2. Unfold the Local and then the Listeners folders to display any available listeners.
If a listener is not available, then you have to create one.
3. Launch the Net Configuration Assistant wizard as an administrator.
The Oracle Net Configuration Assistant: Welcome dialog is displayed.
4. Choose the Listener configuration option, and click Next.
The Oracle Net Configuration Assistant: Listener Configuration, Listener dialog is displayed.
5. Choose Add, and then click Next.
The Oracle Net Configuration Assistant: Listener Configuration, Listener Name dialog opens.

14 Avocet Installation Reference

6. Enter a listener name in the Listener name text box. If required, enter the home user password in
the Oracle Home User Password field. Then click Next.
The Oracle Net Configuration Assistant: Listener Configuration, Select Protocols dialog opens.
7. Add TCP to the Selected Protocols list, and click Next.
The Oracle Net Configuration Assistant: Listener Configuration, TCP/IP Protocol dialog opens,
prompting for the port number.
8. Accept the standard port number 1521, and click Next.
The Oracle Net Configuration Assistant: Listener Configuration, More Listeners? dialog opens,
asking whether you want to add other listeners.
9. Choose No, and click Next.
The Oracle Net Configuration Assistant: Listener Configuration Done dialog is opened, indicating
that the listener configuration is complete.
10. Click Next to return to the Welcome page of the Oracle Net Configuration Assistant wizard, and
click Finish.
11. Launch the Windows Services window, and verify that the OracleOraDB12Home1TNSListener
service is available and running. Ensure that its startup type is Automatic.

Edit the tnsnames.ora, sqlnet.ora, and listener.ora files

You must add the database name, verify sqlnet nts authentication and the names directory path, and
specify the database server name in the *.ora configuration files.
The *.ora files are located under
driveLetter:\app\ORACLE\product\12.1.0\dbhome_1\NETWORK\ADMIN.

1. Open the tnsnames.ora file in a file editor, remove all entries, and then add the following entries,
specifying your your database name where indicated:
Your Database Name=
(DESCRIPTION =
(ADDRESS =(PROTOCOL = TCP) (HOST = localhost) (PORT = 1521))
(CONNECT_DATA =
(SERVER = DEDICATED)
(SERVICE_NAME = Your Database Name)
)
)
ORACLR_CONNECTION_DATA =
(DESCRIPTION =
(ADDRESS_LIST =
(ADDRESS = (PROTOCOL = IPC)(KEY = EXTPROC1521))
)
(CONNECT_DATA =
(SID = CLRExtProc)
(PRESENTATION = RO)
)
)

2. Save the updated tnsnames.ora file.

3. Open the sqlnet.ora file in a file editor, and verify that the following entries are specified:
SQLNET.AUTHENTICATION_SERVICES = (NTS)
NAMES.DIRECTORY_PATH= (TNSNAMES)

4. Open the listener.ora file (if available) in a file editor, and add the fully qualified domain name of
your Oracle database server where indicated:
SID_LIST_LISTENER =
(SID_LIST =

15
 (SID_DESC =
(SID_NAME = CLRExtProc)
(ORACLE_HOME = C:\app\ORACLE\product\12.1.0\dbhome_1)
(PROGRAM = extproc)
(ENVS =
"EXTPROC_DLLS=ONLY:C:\app\ORACLE\product\12.1.0\dbhome_1\
bin\oraclr12.dll")
)
)
LISTENER =
(DESCRIPTION_LIST =
(DESCRIPTION =
(ADDRESS = (PROTOCOL = TCP)
(HOST = YourOracleservername.DIR.CompanyName.com)
(PORT = 1521))
(ADDRESS = (PROTOCOL = IPC)(KEY = EXTPROC1521))
)
)
ADR_BASE_LISTENER = C:\app\ORACLE\product\12.1.0\dbhome_1\
log

5. Save the updated file.

Create VM_DATA and VM_INDEX tablespaces

Avocet requires that you create VM_DATA and VM_INDEX tablespaces. You create the tablespaces
through the Oracle Enterprise Manager web application.
Avocet uses each tablespace for a specific purpose:
• VM_DATA tablespace is used for storing tables, views, and other database objects associated with
the Avocet schema.
• VM_INDEX tablespace is used for storing indexes associated with the Avocet schema.

1. On the system where Oracle is installed, open a web browser and enter the following address:
https://localhost:5500/em.
The Oracle Enterprise Manager login window is displayed.
2. Enter your Oracle installation user name and password, and then check the as sysdba check box.
The Database Home page opens.
3. Choose Storage > Tablespaces.
The Tablespaces windows opens.
4. Click Create.
The Create Tablespace page opens.
5. Select General in the sequence line, and proceed to complete the tablespace options in sequence
for VM_DATA:
Category Options

General Enter VM_DATA in the Name text field.

Choose Permanent as the Tablespace Type.
Choose Smallfile.
Choose Online as the Status.

Add Datafiles Select the Using Oracle-Managed Files check box.

Enter 1 as the Number of Files.
Enter 1000M for the File Size.

16 Avocet Installation Reference

 Category Options

Select the Auto Extend check box.

For Increment size, enter 100M.
Enter Unlimited for Maximum File Size.

Note: Your initial sizing requirements may change

depending on the historical data to be loaded.

Space Select Database Default (8KB) for the Block Size.

Choose Automatic for the Extent Allocation.

Logging Choose Logging.

Segments Choose Automatic for Segment Space Management.

Choose None for Compression.

Then click OK.

A confirmation prompt should display, indicating that the tablespace is created successfully. Click
OK to continue.
6. Return to the Tablespaces windows in Oracle Enterprise Manager, and click Create.
The Create Tablespace page opens.
7. Select General in the sequence line, and proceed to complete the tablespace options in sequence
for VM_INDEX:
Category Options

General Enter VM_INDEX in the Name text field.

Choose Permanent as the Tablespace Type.
Choose Smallfile.
Choose Online as the Status.

Add Datafiles Select the Using Oracle-Managed Files check box.

Enter 1 as the Number of Files.
Enter 1000M for the File Size.
Select the Auto Extend check box.
For Increment size, enter 100M.
Enter Unlimited for Maximum File Size.

Space Select Database Default (8KB) for the Block Size.

Choose Automatic for the Extent Allocation.

Logging Choose Logging.

Segments Choose Automatic for Segment Space Management.

Choose None for Compression.

Then click OK.

A confirmation prompt should display, indicating that the tablespace is created successfully. Click
OK to continue.
8. Return to the Tablespaces window to view the newly created tablespaces VM_DATA and VM_INDEX
in the list of tablespaces.

17
 Create Oracle user
In the Tablespaces window of Oracle Enterprise Manager, you create an Oracle user account for the
tablespaces, specify privileges for the account, and select the quota access to each tablespace.

1. In the Tablespaces window, choose Security > Users.

The Users page opens.
2. Click Create User.
The Create User page opens.
3. Select User Account in the sequence line, and proceed to complete the options in sequence for
your Oracle user account:
Category Options

User Account Specify your Oracle account user name and password.
Accept the default settings in the remaining options.

Tablespaces Select VM_DATA from the Default Tablepace drop-down

list.
Choose TEMP as the Temporary Tablespace selection.

Privilege Add the following privileges to the user account:

• CREATE ANY SYNONYM
• CREATE CLUSTER
• CREATE PROCEDURE
• CREATE PUBLIC SYNONYM
• CREATE SEQUENCE
• CREATE SESSION
• CREATE TABLE
• CREATE TRIGGER
• CREATE VIEW

Logging Choose Logging.

Segments Choose Automatic for Segment Space Management.

Choose None for Compression.

Then click OK.

A confirmation prompt indicating successful processing should display.
4. Return to the Users page, and select the user you just created.
A Details page opens.
5. Select the Quotas tab on the Details page.
The Quotas property details are displayed, listing the tablespaces.
6. Select the VM_DATA tablespace, and choose Edit.
The Alter Quota dialog opens for the VM_DATA tablespace.
7. Enter UNLIMITED for the Quota value, and click OK.
A confirmation prompt indicating successful processing should display.
8. Click OK to return to the Quotas property details, select the VM_INDEX tablespace, and choose
Edit.
The Alter Quota dialog opens for the VM_INDEX tablespace.
9. Enter UNLIMITED for the Quota value, and click OK.
A confirmation prompt indicating successful processing should display.
10. Click OK to return to the Quotas property details.

18 Avocet Installation Reference

 Both the VM_DATA and VM_INDEX tablespaces should the Quota value UNLIMITED assigned to
them.

Configure firewall
You may need to configure a firewall rule depending on your database connection port.

1. On the Oracle database server system, open the Windows Firewall with Advanced Security console.
2. In the Navigation Tree, select Inbound Rules.
The Inbound Rules pane is displayed.
3. Under Actions, choose New Rule... .
The New Inbound Rule Wizard is launched.
4. Select Port for the type of rule to create, and click Next.
The Protocol and Ports page opens.
5. Select the TCP protocol option, and select the Specific local ports option, entering the port number
specified when you created the listener (the standard is 1521). Click Next.
The Action page opens.
6. Choose the action Allow the connection that the firewall should perform when a connection
attempt matches the inbound rule, and click Next.
The Profile page is displayed.
7. Select all connection types: Domain, Private, and Public. Click Next.
The Name page opens.
8. Enter a name for the rule and click Finish.
The rule is created.
9. Open the Services window, and verify that your Oracle service instance is available and running.
Look for an entry OracleService SystemIdentifier, where SystemIdentifier is the system name
assigned to the database name.
The system identifier (or SID) is listed in the Create Database - Summary window of the Database
Configuration Assistant.

Check the Oracle database connection

To test your database connection, you can run the sqlplus connect command from the administrator
instance of the Windows Command Prompt.
You should check the connection from both the local system and a remote

1. Launch the Windows Command Prompt as an administrator.

2. From the C:\Windows\system32 directory, run the following sqlplus command:
C:\Windows\system32>sqlplus OracleUserName/
OraclePassword@DatabaseInstanceName

Note: The Oracle connection string is used to connect with the database instance in the
Avocet Application Initializer data source configuration in the Database Configuration Tools
utility. It follows this syntax:
Data Source =[localhost/DATABASE NAME];
User Id=[User Id];Password=[Password]

localhost Database server where Oracle resides

DATABASE NAME Oracle database instance name

[User Id] Oracle user account name

19
 [Password] Oracle user account password

Oracle Instant Client

This example shows what you MUST do to modify the default connection string when connecting to
the Oracle database using Oracle Instant Client or with a separately installed Oracle client.

Warning! If connecting to an Oracle database with the bundled Oracle Instant Client or connecting
with a separately installed Oracle client (that is, “full Oracle Client”), this step must be performed before
proceeding with the Oracle database initialization. See Oracle Instant Client configuration instructions.
If connecting to an Oracle Instant Client data source, the default connection string will display as
follows.
Data Source=[SERVICE NAME];User Id=[User Id];Password=[Password]

Modify the highlighted text as shown in the example below to connect to your database schema. These
credentials will be identical to the Oracle database schema you created in this procedure.
Data Source=[ORASRVR];User
Id=AVM_Customer;Password:sis

Configuring the Oracle Instant Client Light

This section shows how to configure the Oracle Instant Client Light, modify the AppConfig file, add
international character sets manually, and remove the Oracle Instant Client.
In the previous releases of Avocet, an Oracle standard client was required to be installed on every
machine that was accessing the database through the application. In this release of Avocet, an Oracle
Instant Client Light has been implemented. This implementation no longer requires the Oracle client
to be deployed on client machines and removes the dependency on the correct version of the Oracle
client, including 32- and 64-bit dependencies.

Note: This section assumes you have already configured Oracle to be used with Avocet as
stated in the installation section on setting up a new database schema for Oracle.

Avocet has the capability to connect to an Oracle database in the following ways:
• Connection with the bundled Oracle Instant Client Light
• Connection with a separately installed Oracle client (i.e. “full Oracle Client”)
In both cases, Oracle ODP.Net 11.2.0.2.1 is used by Avocet to connect to Oracle. Any other Oracle
client software deployed on the client machine must be 11.2.0.2.1 or later for Avocet to work correctly.
See the following diagram to help you understand your deployment scenario and how to properly
configure the software.

20 Avocet Installation Reference

Modifying your AppConfig file
To use the Oracle Instant Client, you may need to modify your existing AppConfig file; however, you
are no longer required to set up tnsnames.ora. This task shows how to modify the AppConfig.
As an example, you would translate an old tnsnames.ora entry that looks like this:
AVM =
(DESCRIPTION =
(ADDRESS_LIST =
(ADDRESS = (PROTOCOL = TCP)(HOST = 192.192.192.192)(PORT = 1521))
)
(CONNECT_DATA =
(SID = AVM)
(SERVER = DEDICATED)
)
)
To a connection string like this:
<database>
<driver>ORACLE</driver>
<sqlsyntax>ORACLESQL92</sqlsyntax
<connectString>Data Source=192.192.192.192:1521/AVM;User
Id=myId;Password=myPassword</connectString>
</database>
If the server has a well-defined name, then the connection string would be:
<database>
<driver>ORACLE</driver>
<sqlsyntax>ORACLESQL92</sqlsyntax
<connectString>Data Source=OracleServer.mydomain.com:1521/AVM;User
Id=myId;Password=myPassword </connectString>
</database>
International character sets
This task shows how to add additional character sets manually to your deployment.

21
 Avocet is bundled with the Oracle Instant Client Light, which includes limited Western character sets
and Unicode. This minimal set of DLLs is bundled with Avocet for size and bandwidth considerations.
If you require Eastern languages, Cyrillic, or other extended character sets, you will need to manually
add the Oracle international resource DLLs to your deployment.
The oraciei11.dll file contains the international character sets for 32- and 64-bits. The DLLs need to
be downloaded and copied into the AvocetVM/x86 and AvocetVM/x64 folders respectively.

1. Go to \\Avocettfs.slb.com\AvocetBuild\AvocetMain_2013.1\ClickOnce-OracleSupport\I18n-dlls.
2. Download the oraciei11.dll file that contains the international character sets for 32- and 64-bits.
3. Copy the DLLs to the AvocetVM/x86 and AvocetVM/x64 folders respectively.

Removing the Oracle Instant Client

This task shows how to remove the Oracle Instant Client. It assumes that the Oracle Client is installed
separately from Avocet and is pre-configured to connect to the Avocet database server. It also shows
the command to run so the appropriate files are deleted before building the ClickOnce deployment.
Avocet can also be used with the standard Oracle Client typically found when you have a standard
corporate deployment of Oracle. To use a standard Oracle Client, you must remove the bundled Oracle
Instant client before running or deploying the application. In this scenario, it is assumed the Oracle
Client is installed separately from Avocet and is pre-configured to connect to the Avocet database
server.
For this connection to be successful, the following files in the deployment must be deleted from both
the AvocetVM/x86 and AvocetVM/x64 directories.

Warning: Do NOT remove Oracle.DataAccess.dll from the x86 and x64 directories.
• adrci.exe
• genezi.exe
• oci.dll
• ocijdbc11.dll
• ociw32.dll
• ojdbc5.jar
• ojdbc6.jar
• orannzsbb11.dll
• oraocci11.dll
• oraociicus11.dll
• OraOps11w.dll
• uidrvci.exe
• xstreams.jar
However, the following files should be removed before building the ClickOnce deployment.
To delete the DLLs via batch file, run the following command:

DeleteOracleInstantClient.cmd

rem remove Oracle Instant Client dlls from Avocet deployment

rem run from Avocet directory

del x86\adrci.exe
del x86\genezi.exe
del x86\oci.dll
del x86\ocijdbc11.dll

22 Avocet Installation Reference

 del x86\ociw32.dll
del x86\ojdbc5.jar
del x86\ojdbc6.jar
del x86\orannzsbb11.dll
del x86\oraocci11.dll
del x86\oraociicus11.dll
del x86\OraOps11w.dll
del x86\uidrvci.exe
del x86\xstreams.jar
del x64\adrci.exe
del x64\genezi.exe
del x64\oci.dll
del x64\ocijdbc11.dll
del x64\ociw32.dll
del x64\ojdbc5.jar
del x64\ojdbc6.jar
del x64\orannzsbb11.dll
del x64\oraocci11.dll
del x64\oraociicus11.dll
del x64\OraOps11w.dll
del x64\uidrvci.exe
del x64\xstreams.jar

Configure MS SQL Server reporting services

Follow the vendor's guidelines for installing and configuring MS SQL Server reporting services on your
system.
Verify that the appropriate versions of MS SQL Server, MS Visual Studio, and IIS for Reporting Services
are installed.

1. Refer to the following non-Schlumberger website for information:

https://msdn.microsoft.com/en-us/library/ms159106(v=sql.110).aspx.
2. Ensure that you update your appConfig_ProjectLayer .xml file so that it points to the location of
your report server and web service, as in the example shown below:
<reportingServices>
<url>http://localhost:8080/ReportServer</url>
<webservice>ReportService2005.asmx</webservice>
<defaultPath>/</defaultPath>
</reportingServices>

3. To view your reports in Avocet, go to Reports > Reporting Services in the Navigation Tree.
a) Choose your report from the list.
b) Click Launch Report.

Note: Under File > Options > Report Settings, you can view and modify report settings.
However, unless you have fully configured your reporting services, you will not be able to
access the File > Options > Report Settings feature.

23
Configure a database instance without initializing the application Id
This section shows how to use the Configure Database option of the Database Configuration Tools
utility to configure a fresh Avocet database instance without initializing the application Id. It also
discusses why you might want to use this option to generate your Avocet database.

Note: Refer to the Help topic Avocet Production Data Management System Installation to
initialize an application ID for a fresh database instance.

In this procedure, you use the Configure Database option of the Database Configuration Tools utility
to configure a fresh Avocet database instance, but without initializing the application Id. By using the
Configure Database option instead of Application Initializer, you extend the definitions of an existing
database configuration. That is, your database configuration takes on the existing layer, culture, and
screen definitions of the database that it extends.You cannot customize a database generated through
the Configure Database process as you could a database generated through the Application Initializer
process.
One advantage of using the Configure Database option instead of Application Initializer is that it
is quicker and does not generate the XML configuration files of the initialization process. The Configure
Database option is helpful if you intend to add data to the layer and screen definitions of an existing
implementation structure.
The following flow chart outlines the main stages in the procedure:

Create a fresh database

Refer to the database setup guidelines to decide the best way to create your fresh database.

Add an application Id
After you create a new database in SQL or Oracle, specify the application Id definition. This task
discusses what an application Id does, shows a sample application Id definition, and then describes
the main elements and attributes in the definition.
After you create a new database in SQL or Oracle, you next specify an application Id definition that

24 Avocet Installation Reference

• designates the name of the database as displayed in Avocet
• indicates the existing database (represented by its application Id) that the new database extends
• identifies its database driver and SQL syntax
• specifies its connection string, which includes its database name on the database server and
authentication information
When adding the application Id, you determine which existing database you want to extend or build
on. Consider the elements that the existing database includes, among them being the
• layer hierarchy (AVM, OG_STD, OG_STD_SHELL, and so forth)
• cultures
• configurations
• screen definitions
You can add the application Id definition to any AppConfig_xxx.xml file in the \Config subfolder because
the Database Configuration Tools utility scans all the AppConfig files in the folder.
A sample application Id definition is excerpted below:
<application id="FreshDatabaseInstall2013 [local]"
extends="Oil_Gas]">
<description>FreshDatabaseInstall2013 [local]</description>
<database>
<driver>SQLSERVER</driver>
<sqlsyntax>SQLSERVER</sqlsyntax>
<connectString>Network Library=DBMSSOCN;Data Source=localhost;
Initial Catalog=Install2013;User ID=MyID;
Password=MyPassword;Application Name=AVM</connectString>
<readOnlyConnectString>Network Library=DBMSSOCN;Data Source=
localhost;Initial Catalog= Install2013;User ID=MyID;
Password=MyPassword;Application Name=AVM
</readOnlyConnectString>
<connectStringForSsas>[Connection string that allows SSAS to
connect to Avocet DB]</connectStringForSsas>
</database>
</application>
The following table describes the main elements and attributes that make up this definition:

Element or Attribute Description

Application id specifies the name of the database as it is displayed in Avocet. You can provide any name for the
Avocet display name. This is the name you see when you scroll a drop-down list of databases in
Avocet.

The application Id can be different from the database name in the database server.

extends points to the database (represented by the application Id) that the new database definition
(represented by its application Id) extends or builds on

database driver software component that identifies and accesses the database schema

SQL syntax syntax used to communicate with the database

database connect string contains the information required to connect with the database instance. It includes the name of
the database on the database server (Initial Catalog) and the authentication requirements (User
ID and Password). You obtain this information from your database server configuration.

connect string for SSAS contains the information required to connect with the SQL Server Analysis Services server. This
connection string is used if you are generating data cubes for visualization. See the Avocet Analytics
documentation for more information.

25
Configure the database
After you have created a new database on your database server and entered its application Id definition
in an AppConfig file, restart the Database Configuration Tools utility so it can discover the new
application Id and you can configure the database.
To configure the database, perform these steps in the Database Configuration Tools utility:

1. Select Configure Database to open the Configure Database screen.

2. Select the database provider from the Provider drop-down list.

The provider is the database server in which you created the database.
3. Click the blank drop-down list to display the application Ids, and select the application Id of the
database you want to configure.
Its connection string is displayed. The layer files associated with the application Id (database) that
you are extending are also displayed.
4. Click the Configure Database tab to execute the configuration.
After the configuration process is complete, you can launch Avocet . In the Login dialog, you are
able to retrieve the application Id from the Database drop-down list and log into the database.

Launching the application and choosing login and system implementation

options
This section shows how to launch Avocet, set up the license path, apply colors to identify the source
of data, and display and store datetime values in the local time zone or UTC.

26 Avocet Installation Reference

 In the Login dialog, you can specify which culture (language) to apply to the Avocet GUI. The available
cultures depend on your selections during the database initialization phase. In the Login dialog, you
can also enter the path to the license file or server that supplies your Avocet license.
After you log into the Avocet GUI, you can choose system implementation options, such as the following:
• applying color codes to the data fields to identify the source of data (user-entered, system, data
loader, and so forth)
• viewing and storing datetime values in the local time zone or as Coordinated Universal Time (UTC),
with the option to display the local time zone value as a positive or negative offset of the UTC value

Launching Avocet
This task shows how to launch Avocet so you can configure the application, set up facilities, and load
the required data.

1. From within your Avocet implementation folder, launch AvocetVM.exe.

For example, X:\AvocetVMConfiguration\AvocetVM\AvocetVM.exe.
2. On the Login dialog box, enter your user name and the password.
The Database list default is the application ID you created.
3. Click Login to launch the application.

You can now configure the application, set up facilities, and load data as required.

27
Selecting a culture during login
This task shows how to select a culture during login.

1. From within your Avocet implementation folder, launch AvocetVM.exe. For example, X:\
AvocetVMConfiguration\AvocetVM\AvocetVM.exe.
2. On the Login dialog box, click Advanced to display additional login options.
3. In the Culture dropdown, select a culture.
This Culture dropdown list is populated based on the choices you made during the execution of
the initializer. If resources for that culture are set up, you will see the application change the
resources of the dialog.
4. Click Login to continue.
The application will now display in localized resources.

Setting up a licensing path

This task shows how to set up a license path.

1. From within your Avocet implementation folder, launch AvocetVM.exe. For example, X:\
AvocetVMConfiguration\AvocetVM\AvocetVM.exe.
2. On the Login dialog box, click Advanced to display additional login options.
3. In the License Path field, enter the location of the license files.
The location can be in two forms depending on how you have set up your license server.
• A file path, for example, c:\flexlm\license.dat
• A server path, for example, 1700@avm-licenseserver

28 Avocet Installation Reference

Applying color codes to identify the source of data
This task shows how to customize the Avocet look-and-feel using colors so you can identify the source
of the data that is displayed in the data fields. Data source types to which you can apply colors are
described in a table.
For example, you can assign green to highlight system data, red to highlight user data, and so forth.
The data source types to which you can apply color codes are listed below:

Data source type Description

Acquisition Data, such as production data, that is imported from a non-Avocet application. This non-Avocet
application would be part of the assets purchased by one company from another.

For example, company A buys the assets of company B, including the production data system
PDS. When company A imports PDS data into Avocet, it sets the data loader properties
CREATE_SOURCE and UPDATE_SOURCE to ACQUISITION so that the PDS data is marked
as acquisition data.

An administrator can then apply a color code to the acquisition data. When company A examines
production data in Avocet, it knows which data originates from company B based on the assigned
color code.

CarryForward Data, typically well head, meter, and tank data of a selected facility, that is copied and carried
forward to a subsequent date range (inclusive start date and exclusive end date). Carry forward

29
 Data source type Description

data is usually consistent and unchanging data values that are carried forward to alleviate manual
data entry.

DataLoader Data that originates from an external source, such as an Excel spreadsheet, and is imported into
the Avocet database

SCADA Data that is imported from a SCADA system, such as data historian

User Data or data fields that users have edited or can edit

System Data or data fields that are reserved for system use

To apply color codes to data source types, follow these steps:

1. In the Navigation Tree, select Administration > System Maintenance > Source Type Colors to
display the Source Type Colors – SYSTEM screen.
2. For each source type, select a color to mark the data from the Color drop-down list.

3. After completing your selections, select Home > Actions > Save.
4. Restart the Avocet client and log back into the database to initialize the color code update.
The color codes are applied to the data fields, as in this example showing user data:

30 Avocet Installation Reference

 However, after a user edits the color-coded data and saves the record, the color code changes to
the color assigned to user data. An administrator can nonetheless customize the screen so that
the original data source type is also displayed.

Displaying and storing datetime values (local time zone or UTC)

This section shows how to edit the AppConfig to change the stored datetime values as UTC instead
of local (default). It also shows how to display the UTC offset against the local time zone.
By default, datetime values are stored and displayed in local time zone values.
However, you have the option to store datetime values in Coordinated Universal Time (UTC) while
displaying them in your local time.
You also have the option to display your local time as a positive or negative offset of the UTC value:
that is, <localTime +/- UTC offset>. Choosing the UTC offset display does not affect how the datetime
value is stored.
(You can refer to the Wikipedia article on Coordinated Universal Time for more information about the
UTC format.)

Storing datetime values as UTC

This task shows how to edit the AppConfig file to store datetime values as UTC. The <DateTimeType>
element can be either local (default value) or UTC.
To store datetime values as UTC, you manually add a <DateTimeType> element to the
AppConfig_xxx.xml file of your implementation layer, where xxx denotes your implementation layer
In the AppConfig_xxx.xml file, you add the <DateTimeType> element to the application ID definition
of the Avocet database to which you are connecting.

31
 The <DateTimeType> element has two possible values:
• Local (the default value)
• UTC
<DateTimeType> only accepts UTC as a valid non-default value. If any other value is entered, it reverts
to the default value local.
If you intend to store datetime values in your local time, do not add a <DateTimeType> element to
your AppConfig_xxx.xml file because by default the local datetime values are stored.
: Changing the storage datetime value from local to UTC or from UTC to local does not affect existing
data associated with a datetime. You must convert existing data into the updated time format before
making the manual change in the AppConfig_ xxx .xml file.
To store datetime values as UTC, do the following:

1. Open your AppConfig_xxx.xml file, and go to the <application> ID node that defines the database
to which you are connected. Refer to the following code snippet:

<application id="myApplicationID" extends="OG_STD_Shell [148]">

<description>myApplicationID [local]</description>
<database>
<driver>SQLSERVER</driver>
<sqlsyntax>SQLSERVER</sqlsyntax>
<connectString>Network Library=DBMSSOCN;Data Source=
localhost;Initial Catalog=MyDatabase;User ID=MyUserID;
Password=MyPassword;Application Name=AVM</connectString>
<connectStringForSsas>[Connection string that allows SSAS to
connect to Avocet DB]</connectStringForSsas>
</database>
<DateTimeType>UTC</ DateTimeType>
</application>

2. At the <database> level in the <application> ID node hierarchy, enter the following element and
value (UTC), as shown in the above example snippet:
<DateTimeType>UTC</
DateTimeType>

3. Save the updated AppConfig_xxx.xml file.

4. Start or restart the Avocet client to initialize this change to the local database.
Your storage datetime values are converted from local time to UTC format. Henceforth, any new
data is automatically converted to the UTC format and stored in the database. The DateTime fields
in the Avocet client GUI continue to show values in the local time zone based on the local computer’s
settings.
To revert to the default value (local time), you can either remove the <DateTimeType> element
entirely or remove the UTC entry. Save the file and restart the Avocet client to initialize the change.

Displaying the UTC offset

This task shows how to display the positive or negative UTC offset against the local time zone or the
time setting of the local computer in the Avocet client GUI. The UTC offset only affects the displayed
datetime value, not the storage value. No data is converted.

32 Avocet Installation Reference

To display the UTC offset (plus or minus) against the local time or local computer setting, follow these
steps:

1. Open the Avocet client, and in the ribbon toolbar choose File > Options… .
2. Choose All Screens > Screen Settings to display the Screen Settings options.
3. Select the Show UTC Offset check box.

4. Click Home > Save to save the new setting. To apply the updated setting to a running Avocet client
instance, click Home > Navigation > Reload in the ribbon toolbar.
The UTC offset is displayed in the DateTime field next to the specified local time, as in this excerpt
from the Well Test - <nameOfCompletion> screen (Field Data > Well Reading > Well Test>:

If, as in this example, the offset is negative, then to obtain the UTC time for your time zone you
add the offset to the local time: 11:00:00 + 06:00 = 17:00:00. Similarly, if the UTC offset is positive,
then to obtain the UTC time for your time zone you subtract the offset from the local time.
The offset is also captured in the corresponding row of the History grid in the screen for the
transaction record, as in this example:

33
Avocet upgrade scenarios
Avocet provides a uniform framework for upgrading from earlier to later versions. The only exception
is the upgrade from Avocet 2008.1 SP1. To upgrade from Avocet 2008.1 SP1, you must first upgrade
to Avocet 2012.1 SP1.

Note: When upgrading from Avocet 2012.1, Avocet 2012.1 SP 1, Avocet 2013, and Avocet
2014.1.3 to a later version of Avocet, you have to select and run specified upgrade scripts before
completing the database upgrade process.

The following diagram depicts the fully supported upgrade paths:

The following table lists the supported upgrade paths. From Avocet 2012.1 SP1 and later, you can
upgrade directly to any later version.

Avocet version Supported upgrade path(s)

Avocet 2008.1 SP1 Avocet 2012.1 SP1

Avocet 2012.1 SP1 Avocet 2013.1

Avocet 2014.1
Avocet 2014.1.n
Avocet 2017.1
Avocet 2017.2

Avocet 2013.1
Avocet 2014.1
Avocet 2014.1.n
Avocet 2017.1
Avocet 2017.2

Avocet 2014.1
Avocet 2014.1.n
Avocet 2017.1

34 Avocet Installation Reference

 Avocet 2017.2

Avocet 2014.1.n
Avocet 2014.1.n+1
Avocet 2017.1
Avocet 2017.2

Here are the summary guidelines for upgrading from Avocet 2012.1 SP1 and later:
• Identify the custom XML configuration files in your current implementation that you intend to move
to the new version.
These include all configuration files having the application ID extension that you are moving. For
example, for each uniqueAppConfig _myapplicationID .xml file, you also include all XML configuration
files having the myapplicationID, for example:
• vmConfig_myapplicationID .xml
• Layer\myapplicationID .xml
• CustomNavigators_myapplicationID.xml
• GridReports_myapplicationID.xml
• TransactionDataGridConfig_myapplicationID.xml
• TransactionRollupConfig_myapplicationID.xml
These also include all customized XML configuration files that support your implementation, such as
layer files.
• Identify the project layer DLLs (C# files) that you will need to incorporate in the new binaries
• Create backups of the databases, custom XML configuration files, and DLLs that you intend to move
to the new version.
• Manually copy the custom files, except for the Layer\*.xml file or files, to the corresponding folders
in the new implementation version.
• From your current implementation folder, launch ConfigTools.exe, log into the application ID
(database) whose layer file or files you transferring to the new implementation, and run Meta-Data
Loader to export the layer file or files to the new implementation folder.
• From the new implementation folder, launch DatabaseConfigTools.exe, and run the Upgrade
Manager against every application ID you are advancing.
• From the new implementation folder, launch ConfigTools.exe, log into the application ID (database),
and run Database Initializer. Repeat for each application ID you have copied to the new folder.

About the Avocet 2008.1 SP1 upgrade

You are required to upgrade to Avocet 2012.1 SP1 before upgrading to later versions.

Note: Modifications of the type system during customization might require that Schlumberger
deployment investigate the database for upgrade overlaps with the standard version to ensure
database upgrades are smooth. Please consult the Schlumberger deployment team before
upgrading your database, especially if you have a custom solution.

Two new unit system layers are shipped with the Avocet 2012.1 SP1 release, UnitSystem_Imperial.xml
and UnitSystem_Metric.xml.
Avocet 2012.1 SP1 contains relatively big changes regarding property class, UOM, length, and decimals
for all type properties. These changes are implemented to handle a unit system switch such as Metric
and Imperial. All Avocet type properties that have the same property class can then use the same
UOM, length and decimals. This allows the UOM to be defined for all the property classes in the Metric,
Imperial, or custom unit system layer.

35
 Avocet 2012.1 SP1 has also performed a cleanup on all the type properties that are defined in Avocet
standard layers, such as AVM, OG_STD and OG_CW, OG_SM. This is to assure that these type
properties have correct property classes, UOM, length and decimals in both the Metric and Imperial
unit systems. Also, the UOM, length and decimals definitions have been removed from all type properties
defined in the standard layers having the property class. Additionally, the Configuration Tools utility
(ConfigTools.exe or ConfigTools32.exe) contains a new tool called Storage UOM Editor, which allows
you to view the definitions, to add new property classes, and to modify them.
To streamline upgrading, eliminate data conversion errors, and prevent precision loss in values, Avocet
2012.1 SP1 offers a new tool called Property Class Upgrade Manager. Before you upgrade, this
new tool reports the differences in values between Avocet Volumes Manager 2008.1 SP1 and Avocet
2012.1 SP1 for the UOM, length, and decimals properties. Therefore you can address any differences
in values before the actual upgrade. To compare and report the differences, you need to create a
reference database with Avocet 2012 SP1 layers.
The upgrade occurs in these stages:
• Back up your 2008.1 SP1 database and export the latest custom layer files
• Prepare the 2012.1 SP1 database for comparison
• Perform a property difference analysis between 2008.1 SP1 and 2012.1 SP1
• Set DBInfo extension and data transfer scripts
• Run the upgrade on 2008.1 SP1

Stage 1: Backing up the Avocet Volumes Manager 2008.1 SP1 database and exporting custom
files
This section shows how to back up your database, restore the database to a test upgrade database,
and export the latest custom layer files. These tasks are the first stage in upgrading your 2008.1 SP1
database.
Backing up the Avocet Volumes Manager 2008.1 SP1 database
This task shows how to create a backup of the database configured on the Avocet 2008.1 SP1 version.

Note: Use instructions for Microsoft SQL Server or Oracle RDBMS to back up your database
before performing a database upgrade. It is recommended that a database administrator perform
a database backup before you perform a database upgrade.

To back up the database using Microsoft SQL Server:

1. Launch Microsoft SQL Database Server Management Studio.

2. From the Object Explorer, right-click the database to be backed up and select Tasks > Back Up
from the context menu.
The Back Up Database dialog displays.
3. In the Destination section, click Add to display the Select Backup Destination dialog.
4. Click the browse button to display the Locate Database Files dialog.
5. Select the destination for the backup file, and then click OK.
6. Click OK on the Select Backup Destination dialog.
7. Click OK on the Back Up Database dialog.

Restoring your Avocet 2008.1 SP1 database to a test upgrade database

This task shows how to restore your Avocet Volumes Manager 2008.1 SP1 database to a test database
that you can use to test the upgrade.

36 Avocet Installation Reference

1. After you connect to the appropriate instance of the Microsoft SQL Server Database Engine, in
Object Explorer click the server name to expand the server tree.
2. Expand Databases.
3. Right-click the database and select Tasks > Restore > Database from the context menu.
The Restore Database dialog displays.
4. On the General page, the name of the restoring database appears in the To Database list box.
Complete the remaining items on the page, and then click OK.

Exporting and copying the metadata layer

Avocet stores the entire database configuration in the type system. The type system stores this
information in metadata layers. This task shows how to export and copy the metadata layer before
the upgrade so you can later restore the system to its original state and associate the data correctly.
From the Avocet Volumes Manager 2008.1 SP1 version, export and copy the metadata layer to the
Config/Layer folder of the Avocet 2012.1 version.
To export and copy:

1. From the AvocetVM folder of 2008.1 SP1, launch ConfigTools.exe.

Note: Executables are customized for 32- and 64- bit machines. For example,
ConfigTools32.exe should be used when you are running Avocet on a 32-bit machine and
Configtools.exe should be used when you are running Avocet on a 64-bit machine.
To locate the directory, click the Help menu and choose About. Select the Support
Information tab. This tab lists the application directory where the application is installed and
the configuration file that is used to launch the application.

2. In the Login dialog, enter the User and Password for your system account.
3. Click Login to launch the configuration management application.
4. From the tree, select Database Tools > Meta-Data Loader to display the Meta-Data Loader tab.
5. Click the Export tab to display the Export pane.
6. From the list, select the layer to be exported from the drop-down list.

37
 7. In the Export Filename field, type a location where to export the metadata layer into an XML file.
8. Click Export Layer to export the metadata layer into a file.
9. Repeat these steps for each layer you want to export.
10. Close the ConfigTools application.

Stage 2: Preparing the 2012.1 SP1 database for comparison

The second stage to upgrading your 2008.1 SP1 database is to prepare the 2012.1 SP1 database for
comparison. This section show how to configure a new database instance, add a new application ID,
add the unit system layer to the new application ID, and reinitialize the new database.
Configuring a new database instance on 2012.1 SP1
This task shows how to configure a new database instance using the DatabaseConfigTools.exe
application.
The DatabaseConfigTools.exe application allows you to set up a reference database instance. Configure
a new Avocet database instance that will be used for difference comparisons before upgrading. For
this example, we will name the new instance BBE2012_1_SP1_ToBeReferenced.
To configure a new database instance:

1. From the AvocetVM folder for 2012.1 SP1, launch DatabaseConfigTools.exe.

2. From the tree, select Configure Database to display the Configure Database tab.

38 Avocet Installation Reference

3. From the Provider list, select a provider.
For this example, select SQLSERVER.
4. In the Connection String field, enter the connection string.
For this example, enter the following:
Network Library=DBMSSOCN;Data Source=localhost,1433;Initial Catalog=
BBE2012_1_SP1_ToBeReferenced;User ID=sa;Password=713Avm;Application Name=AVM
5. Provide the remaining necessary information, and then click

on the toolbar.
6. Close the DatabaseConfigTools application.

Adding the new application ID

This tasks shows how to include an application ID in the AppConfig file that points to the newly created
BBE2012_1_SP1_ToBeReferenced database, and then extend the new application ID from
BBE2008_1_SP1_ToBeUpgraded.
To add the new application ID:

1. From the 2008.1 SP1 to the Avocet 2012.1 SP1 version (BBE2012_1_SP1_ToBeReferenced),
copy the exported custom layers to the Layer sub-folder and custom configuration files to the
Config folder.
For example, AppConfig_xxx.xml, vmConfig_xxx.xml.
2. Modify the AppConfig_*.xml file in Avocet 2012.1 SP1 Config folder to add a new application ID,
point it to the new database (BBE2012_1_SP1 ToBeReferenced), and then extend the new
application ID from BBE2008_1_SP1_ToBeUpgraded.
For example:
<application id="BBE2012_1_SP1_ToBeReferenced" hidden="false"
extends="BBE2008_1_SP1_ToBeUpgraded">
<description>BBE2012_1_SP1_ToBeReferenced</description>
<database>
<driver>SQLSERVER</driver>
<sqlsyntax>SQLSERVER</sqlsyntax>
<connectString>Network Library=DBMSSOCN;Data Source=localhost,1433;
Initial Catalog=BBE2012_1_SP1_ToBeReferenced;User ID=sa;
Password=713Avm;Application Name=AVM</connectString>
</database>
</application>

39
 In Avocet 2012.1 SP1, the connection string format most Oracle users are familiar with has changed
and the tnsnames.ora file is no longer needed. The new format is:
Data Source=[HOST]/[SERVICE_NAME];User
Id=[UserId];Password=[Password]
As an example, you would translate an old tnsnames.ora entry that looks like this:
AVM =
(DESCRIPTION =
(ADDRESS_LIST =
(ADDRESS = (PROTOCOL = TCP)(HOST = 192.192.192.192)(PORT=1521))
)
(CONNECT_DATA =
(SID = AVM)
(SERVER =
DEDICATED)
)
)
To a connection string like this:
Data Source=192.192.192.192/AVM;User
Id=myId;Password=myPassword
For example, connections should be specified in the SQL syntax:
<database>
<driver>ORACLE</driver>
<sqlsyntax>ORACLESQL92</sqlsyntax>
<connectString>Data Source=srv148gqh.nam.slb.com/AVM;
User Id=OG_STD_TRUNK_UNIT_TEST;Password=713Avm</connectString>
</database>
Or if the server has a well-defined name:
Data Source=OracleServer.mydomain.com/AVM;
User Id=myId;Password=myPassword

3. Save and close the AppConfig_*.xml.

Copying the 2008.1 SP1 layers and add the unit system layer to the new application ID
This task shows how to copy all the layers from BBE2008_1_SP1_ToBeUpgraded to
BBE2012_1_SP1_ToBeReferenced, and then insert the new unit system layer in
BBE2012_1_SP1_ToBeReferenced after the AvocetVM layer.
For example:
<application id="BBE2012_1_SP1_ToBeReferenced" hidden="false" extends="
BBE2008_1_SP1_ToBeUpgraded">
<description>BBE2012_1_SP1_ToBeReferenced</description>
<database>
<driver>SQLSERVER</driver>
<sqlsyntax>SQLSERVER</sqlsyntax>
<connectString>Network Library=DBMSSOCN;Data Source=localhost,1433;
Initial Catalog=BBE2012_1_SP1_ToBeReferenced;User ID=sa;Password=713Avm;
Application Name=AVM</connectString>
</database>
<layers>
<layer>AVM</layer>
<layer>UnitSystem_Imperial</layer>
<layer>OG_STD</layer>
<layer>US_REGS</layer>
<layer>BBE</layer>

40 Avocet Installation Reference

 </layers>
</application >
If OG_STD_Metric was included in BBE2008_1_SP1_ToBeUpgraded, remove it from
BBE2012_1_SP1_ToBeReferenced. Then insert <layer>UnitSystem_Metric</layer> after the AVM
layer. For example:
<layer>AVM</layer>
<layer>UnitSystem_Metric</layer>
Reinitializing the 2012.1 SP1 database
This task shows how to reinitialize the new database BBE2012_1_SP1_ToBeReferenced with the
latest Avocet layers and the latest custom layer exported from the 2008.1 SP1 database.

1. In the Avocet 2012.1 SP1 folder, launch ConfigTools.exe.

2. From the tree, select Database Tools > Database Initializer to display the Database Initializer
tab.
3. Check the Import Layers option, and then click

.
When complete, a status of Succeeded displays.

Stage 3: Performing a property difference analysis between 2008.1 SP1 and 2012.1 SP1
This section shows how to perform a property difference analysis between 2008.1 SP1 and 2012.1
SP1 and make any changes. From Avocet 2008.1 SP1 to Avocet 2012.1 SP1, some of the type
properties’ UOM, length and decimals have been changed and the value currently stored in Avocet
2008.1 SP1 database might need to be converted from the old UOM to the new UOM.
Reporting UOM, length, and decimals differences
This task shows how to check for all the types that have UOM, length, or decimal changes and generate
a report. Perform this step before you run the upgrade.

41
 To begin the analysis:

1. In the Avocet 2012.1 SP1 folder, launch DatabaseConfigTools.exe.

2. From the tree, select Property Class Upgrade Manager to display the Property Class UOM Upgrade
Manager tab.
3. From the Reference App Id list, select the reference application ID (in this example,
BBE2012_1_SP1_ToBeReferenced).
4. From the Upgrade App Id list, select the upgrade application ID (in this example,
BBE2008_1_SP1_ToBeUpgraded).
5. Click Report Differences to display the differences between databases.

Understanding the report

This topic explains the report that you generated to review the UOM, length, and decimals differences.
• The rows are all the type properties in your database that have actual data.
• The “New UOM”, “New LENGTH”, “New DECIMALS” columns display what will be the value after
you upgrade. If the cell is empty, there is no difference from what you have.
• The "NumOf Values” shows you how many actual values you have for each property.
• The “NumOverLengthRange” shows you whether you have any values large enough that will not fix
the new LENGTH after upgrade.
• The “NumOverDecimalsRange” shows you whether you have any values that will lose precision after
the upgrade.
In the following figure, the two rows of the above report are fully displayed:

Changing property differences

This task shows how to change the length and decimals in the custom layer that were highlighted in
the report. This step is performed before the upgrade so no data will lose precision after upgrade.
To change the properties:

42 Avocet Installation Reference

1. In the Avocet 2012.1 SP1 folder, launch ConfigTools.exe.
2. From the tree, select Configuration Editor Tools > Type Editor to display the Type Editor tab.
3. Select the custom layer.
4. Locate the highlighted type records.
5. Change the UOM, length or decimals to the value displayed in the difference report under UOM,
LENGTH or DECIMALS columns.

For example, in the previous report, INVENTORY.LEVEL needs to have a value of 12 for length
instead of 11, and 8 decimals instead of 2. Modify its length and decimals in the Type Editor on
the custom layer.

Exporting the new custom layer file

This task shows how to export the new custom metadata layer after you made changes to the custom
layer in the previous task.
To export:

1. In the Avocet 2012.1 SP1 folder, launch ConfigTools.exe.

2. From the tree, select Meta-Data Loader to display the Meta-Data Loader tab.
3. Click the Export sub-tab.
4. In the Export Filename field, browse for the modified custom layer to export.
An example of the custom file referenced above will look like:
<LayerDefTypeProperty Type="INVENTORY" PropertyName="LEVEL"
LabelId="TYPE.INVENTORY.LEVEL" Length=”12.0000000000” Decimals="8.000000000000" />

5. Click

43
 Reinitializing the 2008.1 SP1 database with updated custom layer file
This task shows how to reinitialize the 2008.1 SP1 database after you exported the new layer and
copied it to Avocet 2008.1 SP1 Config\Layer folder.
To reinitialize:

1. In the Avocet 2008.1 SP1 folder, launch ConfigTools.exe.

2. From the tree, select Database Tools > Database Initializer to display the Database Initializer
tab.
3. Check the Import Layers option, and then click Initialize .
When complete, a status of Succeeded displays.

4. Redo the comparison until you do not see any differences.

Stage 4: Set up DBInfo extension and data transfer scripts

This section explains the new table creation. It also shows how to set up DBInfo extensions and data
transfer scripts that you need to run before upgrading if you have added to the transaction types or if
you remapped standard Avocet properties to different table columns.
To improve performance for any database that contains large volumes of data, Avocet 2012.1 SP1
moved allocation result and process logs to their own physical tables. The upgrade will handle new
table creation and data transfer from existing tables to the new ones.
Below are the transaction types that have been moved from existing tables to newly created tables:

Transaction Types Old Table New Table

Allocation Results

ACTUAL ITEM_EVENT_DBL_EXT IE_ACTUAL

ACT_DAY ITEM_EVENT_DBL_EXT IE_ACT_DAY

44 Avocet Installation Reference

ACT_MTH ITEM_EVENT_DBL_EXT IE_ACT_MTH

ITEM_ACTUAL ITEM_EVENT_TRPL_EXT IE_ITEM_ACTUAL

ITEM_ACT_DAY ITEM_EVENT_TRPL_EXT IE_ITEM_ACT_DAY

ITEM_ACT_MTH ITEM_EVENT_TRPL_EXT IE_ITEM_ACT_MTH

FLOW ITEM_EVENT_TRPL_EXT IE_FLOW

FLOW_DAY ITEM_EVENT_TRPL_EXT IE_FLOW_DAY

FLOW_MTH ITEM_EVENT_TRPL_EXT IE_FLOW_MTH

ITEM_FLOW ITEM_EVENT_QUAD_EXT IE_ITEM_FLOW

ITEM_FLOW_DAY ITEM_EVENT_QUAD_EXT IE_ITEM_FLOW_DAY

ITEM_FLOW_MTH ITEM_EVENT_QUAD_EXT IE_ITEM_FLOW_MTH

ITEM_INV ITEM_EVENT_TRPL_EXT IE_ ITEM_INV

ITEM_INV_DAY ITEM_EVENT_TRPL_EXT IE_ITEM_INV_DAY

ITEM_INV_MTH ITEM_EVENT_TRPL_EXT IE_ ITEM_INV_MTH

ITEM_TICKET ITEM_EVENT_QUAD_EXT IE_ ITEM_TICKET

Process logs

PROC_GRP_LG_RF ITEM_EVENT_DBL_EXT IE_PROC_GRP_LG_RF

PROC_GRP_LOG ITEM_EVENT_EXT IE_PROC_GRP_LOG

PROC_LOG_HDR ITEM_EVENT_EXT IE_PROC_LOG_HDR

PROC_LOG_REF ITEM_EVENT_DBL_EXT IE_PROC_LOG_HDR

PROCESS_LOG ITEM_EVENT_EXT IE_PROCESS_LOG

Before upgrade, please check all custom layers and see if there are any modifications done to the
transaction types that have been moved.
If in the custom layer new properties have been added to the transaction types above; or if standard
Avocet properties have been remapped to different table columns, you need to set up the DBInfo
extension and data transfer scripts before running the upgrade. Otherwise, skip the rest of stage 4
and continue with stage 5.
To set up DBInfo extension and data transfer scripts
This task shows how to set up the DBInfo extension and data transfer scripts when a standard Avocet
property was remapped to a different table column.
An example showing a standard Avocet property having been remapped to a different table column
is described below. OWNER has been added to the ACTUAL transaction type and mapped to column
CHAR7:
<LayerDefTypeProperty Type="ACTUAL" PropertyName="OWNER" LabelId="TYPE.ACTUAL.OWNER"
ColumnName="CHAR7" PropertyType="TEXT" Unicode="False" SortOrder="35"
Mandatory="False" Hidden="False" IsKey="False" />
This property OWNER needs to be added to the physical schema table at the custom layer by defining
custom extension for DBInfo. And this property needs to be included in data transfer scripts to indicate
how to move the existing OWNER data to new tables. You need to follow the same procedure if new
properties are added to the transaction types in the custom layer.

45
 Follow these steps to set up DBInfo extension and data transfer scripts:

1. Create the DBInfo extension file by doing one of the following:

• If the modified transaction type is process log related, please make a copy of the DBInfo.xml
under Config\DBInfo folder. Rename it to DBInfo_CustomExt.xml.
• If the modified transaction type is allocation result related, please make a copy of the
DBInfo_OG_STD.xml under Config\DBInfo folder. Rename it to DBInfo_CustomExt.xml.

2. Customize the DBTable in the DBInfo extension file.

a) Open DBInfo_CustomExt.xml.
b) Go to the DBTable section in the file and remove every DBTable except the section for the
transaction type that has been changed.
For example, the user has added OWNER to the ACTUAL transaction type above. We will remove
all the DBTable content except the “IE_ACTUAL” definition.
<Tables>
<DbTable Name="IE_ACTUAL" TablespaceName="PRIMARY">
<Columns>
<DbColumn Name="EVENT_GROUP_ID" Precision="32" IsIdentity="False"
IsNullable="True" LogicalDbType="Char" />
…
</Columns>
</DbTable>
</Tables>

3. Add/modify properties in DBInfo extension.

Add the custom property to the DBInfo extension by inserting a new DBColumn.
For example add this OWNER to the end of the DBTable section for the “IE_ACTUAL” table:
<Tables>
<DbTable Name="IE_ACTUAL" TablespaceName="PRIMARY">
<Columns>
<DbColumn Name="EVENT_GROUP_ID" Precision="32" IsIdentity="False"
IsNullable="True" LogicalDbType="Char" />
…
<DbColumn Name="OWNER" Precision="10"
IsIdentity="False" IsNullable="True"
LogicalDbType="Varchar" />
</Columns>
</DbTable>
</Tables>

4. Include the DBInfo extension in the application ID.

In the Avocet 2012.1 SP1 Config folder, modify your AppConfig_*.xml file application ID to include
the new DBInfo extension:
<dbInfo>
<base>DbInfo.xml</base>
<extension>DbInfo_OG_STD.xml</extension>
<extension>DbInfo_CustomExt.xml</extension>
</dbInfo>

5. Modify data transfer scripts to transfer custom properties during upgrade.

In the Avocet 2012.1 SP1 Config\UpgradeScripts folder, modify the data transfer scripts
(2012-03-30 allocation datatransfer.xml or 2012-04-18 process datatransfer.xml) to include the
new column in the TransferDbColumn section.

46 Avocet Installation Reference

 You need to use the 2012.1 SP1 column name as sourceColumnName and use the property name
as DestinationColumnName.
For example, add this line to data transfer scripts in 2012-03-30 allocation datatransfer.xml under
TransferDbColumn section; and use “CHAR7” as SourceColumnName.
<TransferDbTable Id="ACTUAL" SourceTableName="ITEM_EVENT_DBL_EXT"
DestinationTableName="IE_ACTUAL" UniqueSourceColumns="ROW_ID"
BatchRecordsCount="1000">
<Columns>
<TransferDbColumn SourceColumnName="EVENT_GROUP_ID"
DestinationColumnName="EVENT_GROUP_ID" />
…
<TransferDbColumn SourceColumnName="CHAR7"
DestinationColumnName="OWNER" />
</Columns>
</TransferDbTable>

6. Save the changes to the DBInfo_CustomExt.xml file and the data transfer scripts.
Now you can execute the upgrade.

Stage 5: Executing the upgrade on 2008.1 SP1

This section shows how to upgrade the database, change the upgraded application ID to add the new
unit system layer, reinitialize the updated application ID with the latest Avocet layers and custom layers,
and launch Avocet after the upgrade.
Running the database upgrade
This task shows how to upgrade selected databases and also lists some reasons why the upgrade
could fail.

1. In the Avocet 2012.1 folder, launch DatabaseConfigTools.exe.

2. From the tree, select Upgrade Manager to display the Upgrade Manager tab.
3. From the list, select the database you want to upgrade.
4. Check the upgradeable items.

47
 5. Click

to run the upgrade.

The results will look similar to the following:

In the previous figure, some upgrades failed due to the following errors:
• Column names in each table must be unique. Column name 'CHAR11' in table
'ITEM_EVENT_EXT' is specified more than once.
• Column names in each table must be unique. Column name 'VAL61' in table 'ITEM_EVENT_EXT'
is specified more than once.

Note: If the type of errors listed above appear during the upgrade process, analyze any
customizations that have been made to the listed tables for conflicts. Contact the Schlumberger
deployment team to address the issues.

Changing the upgraded 2008.1 SP1 application ID to add the new unit system layer
This task shows how to add the new unit system layer.

1. In the Avocet 2012.1 SP1 folder, modify the AppConfig_*.xml file application ID,
BBE2008_1_SP1_ToBeUpgraded, by adding new unit system layers as follows: <layer>AVM</layer>
<layer>UnitSystem_Imperial</layer>.

48 Avocet Installation Reference

 Note: If OG_STD_Metric was included previously in this application ID, remove it, and then
insert<layer>UnitSystem_Metric</layer>.

2. Save the AppConfig_*.xml file.

Reinitializing the upgraded 2008.1 SP1 application ID with the latest 2012.1 Avocet layers and
updated custom layer files
This task shows how to reinitialize the upgraded application ID with the latest Avocet layers and custom
layer files.

1. In the Avocet 2012.1 folder, launch ConfigTools.exe.

2. From the Database list on the Login screen, select BBE2008_1_SP1_ToBeUpgraded.
3. From the tree, select Database Tools > Database Initializer to display the Database Initializer
tab.
4. Check the Import Layers option, and then click Initialize.
When complete, a status of Succeeded displays.

Running Avocet after the upgrade

After launching Avocet 2012.1 and connecting to the newly updated database, verify there are no
problems. If there are any problems, contact the Schlumberger deployment team.

Upgrade workflow example

This section uses an Avocet 2012.1 SP1 to Avocet 2013.1 upgrade as an example workflow to
demonstrate the typical upgrade process. You can adapt this to other upgrade scenarios.
Depending on the level of customization, your upgrade requires different considerations. A highly
customized implementation requires careful attention to the XML configuration files and DLLs that
need to be advanced to the new implementation.

Stage 1: Backing up the Avocet 2012.1 SP1 database and exporting custom files
This section shows how to backup the Avocet database and export the metadata layer. It is
recommended that a database administrator perform a database backup before you perform a database
upgrade.

Note: Use instructions for Microsoft SQL Server or Oracle RDBMS to back up your database
before performing a database upgrade.

Refer to the Avocet upgrade scenarios Help topic to identify the customized files that you need to back
up and copy.
Backing up the Avocet 2012.1 SP1 database (MS SQL Server)
This task shows how to back up the database using Microsoft SQL Server.

1. Launch Microsoft SQL Database Server Management Studio.

2. From the Object Explorer, right-click the database to be backed up and select Tasks > Back Up
from the context menu.
The Back Up Database dialog displays.
3. In the Destination section, click Add to display the Select Backup Destination dialog.
4. Click the browse button to display the Locate Database Files dialog.
5. Select the destination for the backup file, and then click OK.

49
 6. Click OK on the Select Backup Destination dialog.
7. Click OK on the Back Up Database dialog.

Exporting the metadata layer

Avocet stores the entire database configuration in the type system. The type system stores this
information in meta data layers. This task shows how to export the metadata layer before the upgrade
so you can later restore the system to its original state and associate data correctly.
For more information on the type system, refer to the online Help.
To export the layer:

1. From the AvocetVM folder of 2012.1 SP1, launch ConfigTools.exe.

Note: Executables are customized for 32- and 64- bit machines. For example,
ConfigTools32.exe should be used when you are running Avocet on a 32-bit machine and
Configtools.exe should be used when you are running Avocet on a 64-bit machine.

2. In the Login dialog, enter the User and Password for your system account.
3. Click Login to launch the configuration management application.
4. From the tree, select Database Tools > Meta-Data Loader to display the Meta-Data Loader tab.
5. Click the Export tab to display the Export pane.
6. From the dropdown list, select the layer to be exported from the drop-down list.
7. In the Export Filename field, type a location where to export the metadata layer into an XML file.
8. Click Export Layer to export the metadata layer into a file.
9. Repeat these steps for each layer you want to export.
10. Close the ConfigTools application.

Stage 2: Executing the upgrade

This section discusses the upgrade scripts that are available in the DatabaseConfigTools. It also shows
how to upgrade the database, see which updates were applied, select scripts to never run, and
reinitialize the upgraded application ID.
The Avocet database is typically updated from version to version with new types, processing routines,
navigators, and so forth. For example, the Avocet 2013.1 database supplies the following new features
in comparison with Avocet 2012.1 SP1:
• Network diagrams now reside in their own tables instead of BLOBs.
• SQLite is supported only for disconnected field laptops having single users.
• Tag map caching has been implemented.
• TAG_MAPS have been moved to their own tables.
• The caching of compressed security content has been enhanced.
To enable your current database version to support the new features, you can execute selected
upgrade scripts.
The Database Configuration Tools utility (DatabaseConfigTools.exe) offers an Upgrade Manager
feature that scans your current database for existing scripts. It then lists the scripts that are
• not installed on your database
• available to be applied in the current upgrade session
Using the Upgrade Manager, you can
• select which scripts to initialize

50 Avocet Installation Reference

• deselect scripts so that they do not run during the upgrade session
• display which script updates have been applied to the database
• mark scripts that you do not want to run
The Upgrade Manager lists scripts in chronological order, beginning with the earliest one that is not
installed on the database.
In earlier Avocet versions, you could only run an upgrade script once. Subsequent attempts to execute
the script would result in an error. However, more recent scripts can be run multiple times without
generating an error.
You can run the following scripts multiple times across upgrade sessions without them failing the
initialization process. The scripts are listed in chronological order from top to bottom, starting at the
top of the left-hand column and ending at the bottom of the right-hand column:

Script Script

Tank Density Method Changes – 2 Missing DB Objects Script – 2012-09-14

WBS image property name change Missing DB Objects Script – 2012-10-19

CompAnalysis Upgrades Add ORIGDAY to Primary Key

Security Cache Upgrade Update Navigators for Support SQLite 2013-01-22

Missing DB Objects Script Missing DB objects Script 2013-01-28

Allocation Data Transfer Missing DB objects Script 2013-02-20

Resource ID length increase Inventory Data Transfer

Process Data Transfer Security Cache Upgrade 2

Rename Process tables ROWSTATUS Column New – Type UOM Upgrades

TAGCACHE table creation script New Resource ID length increase script

Diagram Data Upgrade Missing DB Objects Script 2013-04-01

Upgrade existing TAGMAPs TAGMAP Data Transfer

Pipeline CAPACITYUOM to CAPACITY_UOM_CD sql Drop Row id and DB ID Column from DIAGOBJECT_CACHE

The following screenshot shows the first part of the list of scripts that can be run multiple times. To
summarize, you can run the Tank Density Method Changes - 2 script and all following scripts multiple
times across upgrade sessions.

51
 To execute the upgrade
This task shows how to perform a script upgrade to the selected application ID that references the
target database.
If upgrading from Avocet 2012.1 or Avocet 2012.1 SP1, you have to execute a preliminary upgrade
before completing the formal upgrade.

Note: If you are upgrading from Avocet 2013 or Avocet 2014.1.3 to 2017.2, you have to execute
a preliminary upgrade before completing the formal upgrade. For more details please refer to
the following section To execute the preliminary upgrade from Avocet 2013 to 2017.2 and To
execute the preliminary upgrade from Avocet 2014.1.3 to 2017.2 respectively.

1. In the implementationFolder\AvocetVM folder, launch DatabaseConfigTools.exe.

2. From the tree, select Upgrade Manager to display the Upgrade Manager screen.
By default, the Upgrade Manager screen lists the available 2013.1 upgrade scripts.

52 Avocet Installation Reference

3. From the database list, select the application id to connect to.
The application Id references the database you want to upgrade.
The Upgrade Manager displays the corresponding scripts that have updates you can apply to the
target database:

53
 Note: This list may differ from the default list, depending how long it has been since your
last upgrade.

4. Review the selected scripts and de-select the ones you do not want to submit for upgrading in the
current session.
After you execute the upgrade, the unselected scripts are denoted as Not Run for the upgrade
session.
5. Click Upgrade in the Upgrade Manager taskbar to apply the scripts to your database and initialize
the selected ones.
The upgrade status of each script is displayed in the right-hand side panel. For example, a successful
upgrade is noted with a green checkmark as in the following example:

When a script fails the upgrade, it is noted with an X mark against a red background. You can click
on the X to view the accompanying error message. An example error message is shown below:

54 Avocet Installation Reference

You can export these errors to an Excel spreadsheet by clicking the Export Errors to Excel button
at the bottom of the panel.

Any unselected scripts that are part of the upgrade session are marked with an X against a black
background. The flyout message Not Run is displayed when the mouse pointer hovers over the X.

To summarize, scripts that are included in an upgrade session can have a status of
• success
• failed

55
 • not run

To execute the preliminary upgrade from Avocet 2013 to 2017.2

If upgrading from Avocet 2013, you have to execute a preliminary upgrade before completing the
formal upgrade.

1. From the database list, select the application id to connect to the application id references for the
database you want to upgrade.
2. Click Show Applied Updates to show all scripts in the Upgrade Manager list.
3. Scroll down and select the Add Table VALIDATION_LOG - 2015-05-05 check box as shown in
the below screen:

4. Click Upgrade and make sure the script runs successfully.

To execute the preliminary upgrade from Avocet 2014.1.3 to 2017.2

If upgrading from Avocet 2014.1.3, you have to execute a preliminary upgrade before completing the
formal upgrade.

1. From the database list, select the application id to connect to the application id references for the
database you want to upgrade.
2. Click Show Applied Updates to show all scripts in the Upgrade Manager list.
3. Scroll down and select the Missing DB Objects Script - 2016-12-12 and IEREPL_LOG Table
update - 2017-04-04 check box as shown in the below screen:

4. Click Upgrade and make sure the script runs successfully.

56 Avocet Installation Reference

To show applied updates
This task shows how to view scripts that have been executed against a database.

1. Select an application Id (database) from the database drop-down list.

2. Click Show Applied Updates.
The scripts that have been executed against the database are listed in the left-hand panel:

Any upgrade or other action does not affect the scripts that have already been applied to the
database.

Using the Never Run Option

This topic discusses the Never Run option and why you might want to mark scripts not to run during
the upgrade session.
For example, you may not want to run a script that overrides or interferes with a custom script which
you have created.
For internal tracking purposes, a script marked as Never Run is flagged as Succeeded, even though
it is not executed. The script marked Never Run is moved to the right-hand side panel where it is
displayed. The Never Run designation persists for the upgrade session, but the script reverts to its
previous status after the session terminates.
Troubleshooting considerations
This topic discusses some reasons why script upgrades could fail.
Some script upgrades can fail because of errors similar to the following:

57
 • Column names in each table must be unique. Column name 'CHAR11' in table 'ITEM_EVENT_EXT'
is specified more than once.
• Column names in each table must be unique. Column name 'VAL61' in table 'ITEM_EVENT_EXT'
is specified more than once.
If the type of errors listed above appear during the upgrade process, it means that the columns already
exist in the specified table.You can contact the Schlumberger deployment team to address any issues.
Reinitializing the upgraded 2012.1 SP1 application ID with the latest 2013.1 Avocet layers
This task shows how to initialize the updated application ID to the latest Avocet layers.

1. In the Avocet 2013.1 folder, launch ConfigTools.exe.

2. From the Database list on the Login screen, select the Application ID of the database to be
upgraded.
3. From the tree, select Database Tools > Database Initializer to display the Database Initializer
tab.
4. Check the Import Layers option, and then click Initialize.
When complete, a status of Succeeded displays.

Database upgrade from Avocet 2012.1 or Avocet 2012.1 SP 1

The database upgrade from Avocet 2012.1 or Avocet 2012.1 SP 1 to a later version requires that you
manually select and run specified upgrade scripts before executing the formal database upgrade.
Beginning with Avocet 2013.1, each upgrade script that has executed successfully is stored in the
database under the key VER_TYPE = 'DB_VERSION'. In Avocet 2012.1 and 2012.1 SP 1, only the
last successful upgrade script was stored under the key VER_KEY = 'DB_UPG_VER'.
Consequently when you connect with a 2012.1 or 2012.1 SP 1 database with a later Avocet version,
the newer Avocet version retrieves scripts that are present after the last upgrade script was successfully
executed in the 2012.1 or 2012.1 SP 1 database. These scripts have not been executed. They are
listed below:
• Security Cache Upgrade
• TAGSCACHE table creation script
• Diagram Data Upgrade
• Upgrade Existing TAGMAPS
• Update Navigators for Support SQLite - 2013-01-22
• Missing DB Objects Script - 2013-01-28
• Missing DB Objects Script - 2013-02-20
• New Resource ID length increase Script
• Missing DB Objects Script - 2013-04-01
• TAGMAP Data Transfer (Takes a Long Time to Complete Backup in %TEMP%)
• Drop row id and DB ID Column from DIAGOBJECT_CACHE
• Update Tank Strap
• Missing DB Objects Script - 2013-07-12
• Update Tank Strap Deal
• Remove obsolete restrictions in DB Objects - 2013-11-13
You have to run these scripts before continuing to the formal database upgrade for Avocet 2012.1 or
Avocet 2012.1 SP1. Otherwise your upgrade attempt fails, and you receive an error message related
to table resolution of a telemetry setting.

58 Avocet Installation Reference

Execute preliminary upgrade scripts for Avocet 2012.1 and Avocet 2012.1 SP 1
When upgrading from Avocet 2012.1 or Avocet 2012.1 SP 1, you must first run specified preliminary
upgrade scripts before continuing to the formal upgrade process.
Copy your Avocet 2012.1 or Avocet 2012.1. SP 1 project configuration files from their
installationDirectory/AvocetVM/Config folder and paste them to the /AvocetVM/Config folder of your
target Avocet installation, for example Avocet 2017.1. These files include all your Avocet project
implementation files:
• AppConfig_ ImplementationName .xml
• ImplementationName .xml layer file
• vmConfig_ ImplementationName .xml
• CustomNavigators_ ImplementationName .xml
• GridReports_ ImplementationName .xml
• TransactionDataGridConfig_ ImplementationName .xml
• TransactionRollupConfig_ ImplementationName .xml
Your customizations may extend to other configuration files as well, so be sure to copy and paste
them.

1. In the installationFolder\AvocetVM folder of your target Avocet installation, launch

DatabaseConfigTools.exe.
2. From the Tree, select Upgrade Manager to display the Upgrade Manager pane.
By default, the Upgrade Manager displays the available upgrade scripts.
3. From the App Id drop-down list, select the application Id of your Avocet 2012.1 or Avocet 2012.1
SP 1 implementation to which to connect.
This the application Id that references the 2012.1 database you want to upgrade.
4. Click Show Applied Updates.
5. Select the upgrade scripts listed in the topic and as highlighted in the following screenshot:

59
 6. Click Upgrade.
The selected scripts are applied to the database.
7. Select another screen in the Database Configuration Tools utility and then return to the Upgrade
Manager node to refresh the screen display.
8. From the App Id drop-down list, reselect the application Id of your Avocet 2012.1 or Avocet 2012.1
SP 1 implementation to which to connect.
9. Click Upgrade.
The remaining upgrade scripts should execute successfully.

60 Avocet Installation Reference

Configuration updates for manual upgrades
Whenever you upgrade to a newer Avocet version, review your XML configuration files, located in the
installDirectory \AvocetVM\Config folder, to ensure that you have the latest updates. This review is
especially important if you have customized your configuration files. For example, if you have modified
the default AppConfig and vmConfig XML files, be sure that you incorporate the latest changes to
your project layer versions.

Configuration update Description

Remove references to deprecated Avocet 2017.x does not support Avocet UA Server and the Visualization Designer. In
features your Avocet 2017.x deployment, remove references to them.

DiagramConfigWPF_base.xml These files enable the daily and monthly report functionality in Avocet. They were first
introduced in the 2012.1 SP1 version. Verify that they are in your Config subfolder.
DiagramConfigWPF_OG_STD.xml

<mailSettings> Effective in the 2014.1.2 release, this element is now defined immediately below the
<application id = projectLayer> node of the AppConfig_ projectLayer file and in the
AppInitConfig.xml file. It is no longer defined under the <alarms> node.

Custom vmConfig_<LayerName> Upgrade users must manually update the "id" and "screenConfig" nodes in custom
vmConfig_<LayerName>.xml from "Scada.TagMap" to "Scada.TagMapXaml".

<balanceConfig> Upgrade users must manually add the

<balanceConfig>BalanceConfig.xml</balanceConfig> tag to the
appconfig_[implentationLayer].xml file. For information, refer to the
BalanceConfig.xml file topic located under the Diagram Editor section.

Remove references to deprecated features

Upgrade users must delete certain configuration files and remove tags that point to deprecated features.
Effective in Avocet 2017.2, the Avocet UA Server and Visualization Designer have been deprecated.
Consequently, as an upgrade user, you should remove configuration files and settings that point to
these features.

1. In the installationDirectory\AvocetVM\Config subfolder, remove the following files:

• DbInfo_OPCUAServer.xml
• vmConfig_OPCUAServer.xml

2. In the installationDirectory\AvocetVM\Config\Layer subfolder, remove the OPCUAServer.xml layer

file.
3. In the installationDirectory\AvocetVM implementation folder, remove the
Slb.Avocet.OPCUAServerObjects.dll file.
4. Open your AppConfig_ProjectLayer.xml file, remove the following entries, and save the file:
• Dbinfo_OPCUAServer.xml extension from the <dbInfo> node
• vmConfig_OPCUAServer.xml extension from the <vmConfig> node
• OPCUAServer.xml layer file from the <layer> node

5. Open your vmConfig_ProjectLayer.xml file, remove the following entries, and save the file:
• node type definition for TreeNode.Visualization
• corresponding screen configuration ID
Slb.Avocet.OPCUA.Client.Screens.VisualizationWellOverview

Add the DiagramConfigWPF files

This task shows how to update your AppConfig and vmConfig files.

61
 Two new files have been added:
• DiagramConfigWPF_base.xml
• DiagramConfigWPF_OG_STD.xml
Be sure to include these two files in your Config subfolder.
In the default AppConfig_OG_STD_Shell.xml file, you see the <diagramConfigWPF> element
definition that points to these two files:
<diagramConfigWPF>
<base>DiagramConfigWPF_base.xml</base>
<extension>DiagramConfigWPF_OG_STD.xml</extension>
</diagramConfigWPF>
Add this definition to your AppConfig_< custom>.xml file.
Next, review the default vmConfig_OG_STD_Shell.xml and vmConfig_OG_STD.xml files to see
the updated <node> and <screenConfig> definitions. Use DiagramWPF as a search string. Note that
the previous definitions are commented out. After reviewing the updated definitions in the default
vmConfig_< xxx >.xml files, you can apply the updates to your custom file.
Ensure that your custom screen configuration file vmConfig_<custom>.xml includes the following
node definitions for the new daily diagram report and monthly diagram report. under the corresponding
folder node definitions.
Daily diagram report

<node type="Screen" id="DiagramWPF.DailyReportDiagram" platform="desktop">

<titleRes>TreeNode.DiagramWPF.DailyReportDiagram</titleRes>
<text>Daily Report Diagram</text>
<icon type="resource" id="TreeNode.Icon.Diagram" />
<config>
<navigatorType>NETWORK</navigatorType>
<screenConfigs>
<screenConfig>DiagramWPF.DailyReportDiagram
</screenConfig>
</screenConfigs>
</config>
</node>

The new screen ID “DiagramWPF.DailyReportDiagram” takes the place of the previous screen ID:
Slb.AvocetVM.Client.Screens.Reports.InputDiagramDaily
After adding the new node definition, comment out or remove the previous one.
Monthly diagram report
<node type="Screen" id="DiagramWPF.MonthlyReportDiagram" platform="desktop">
<titleRes>TreeNode.DiagramWPF.MonthlyReportDiagram</titleRes>
<text>Monthly Report Diagram</text>
<icon type="resource" id="TreeNode.Icon.Diagram" />
<config>
<navigatorType>NETWORK</navigatorType>
<screenConfigs>
<screenConfig>DiagramWPF.MonthlyReportDiagram</screenConfig>
</screenConfigs>
</config>
</node>
The new screen ID “DiagramWPF.MonthlyReportDiagram” takes the place of the previous screen ID:

62 Avocet Installation Reference

Slb.AvocetVM.Client.Screens.Reports.InputDiagramMonthly
After adding the new node definition, comment out or remove the previous one.
In addition, you need to include an updated TreeNode.Diagrams ID screen node under the
Folder.Allocation ID folder node. Be sure to incorporate the <screenConfig> attribute
DiagramWPF.DiagramEditor.Standard, as shown in the following example:
<node type="Screen" id="TreeNode.Diagrams" platform="desktop">
<titleRes>TreeNode.Diagram</titleRes>
<text>Diagram</text>
<icon type="resource" id="TreeNode.Icon.Diagram" />
<config>
<navigatorType>NETWORK</navigatorType>
<screenConfigs>
<screenConfig>DiagramWPF.DiagramEditor.
Standard</screenConfig>
</screenConfigs>
</config>
</node>
After updating the TreeNode.Diagrams ID screen node, comment out or remove any conflicting node
definitions.
You next add or update <screenConfig> definitions for the new daily reports and monthly reports.
Then you remove or comment out the <screenConfig> definitions that they replace. See the following
snippets for the respective examples:
Daily report:
<screenConfig id="DiagramWPF.DailyReportDiagram">
<titleRes>Screen.DiagramWPF.DailyReportDiagram</titleRes>
<typeScreen type="NETWORK">
<config>
<screen>Slb.AvocetVM.Client.DiagramWPF.DiagramEditor.
ReadOnly</screen>
<Args Key="DiagramMode">
<Value>ReadOnly</Value>
</Args>
<Args Key="TransactionViewIds">
<Value>
<ArrayOfString>
<string>GENERAL_VOLUME_DAY</string>
<string>ALLOC_OIL_VOLUME_DAY</string>
<string>ALLOC_GAS_VOLUME_DAY</string>
</ArrayOfString>
</Value>
</Args>
</config>
</typeScreen>
</screenConfig>
The new screen configuration ID DiagramWPF.DailyReportDiagram takes the place of the previous
one, Diagram.InputVolumesDaily. Remove or comment out the stanza containing the
Diagram.InputVolumesDaily definition.
Monthly report
<screenConfig id="DiagramWPF.MonthlyReportDiagram">
<titleRes>Screen.DiagramWPF.MonthlyReportDiagram</titleRes>
<typeScreen type="NETWORK">
<config>
<screen>Slb.AvocetVM.Client.DiagramWPF.DiagramEditor.

63
 ReadOnly</screen>
<Args Key="DiagramMode">
<Value>ReadOnly</Value>
</Args>
<Args Key="TransactionViewIds">
<Value>
<ArrayOfString>
<string>GENERAL_VOLUME_MTH</string>
<string>ALLOC_OIL_VOLUME_MTH</string>
<string>ALLOC_GAS_VOLUME_MTH</string>
</ArrayOfString>
</Value>
</Args>
</config>
</typeScreen>
< </screenConfig>
The new screen configuration ID DiagramWPF.MonthlyReportDiagram takes the place of the previous
one, Diagram.InputVolumesMonthly. Remove or comment out the stanza containing the
Diagram.InputVolumesMonthly definition.

Update the mailSettings element

In your appConfig_ projectLayer file, verify that the <mailSettings> definition node is below the top-level
<application> node.
If you are creating a new application instance, verify that the <mailSettings> definition is added to the
<application> node of the appInitConfig.xml file.

1. Open your appConfig_ projectLayer file, and locate the top-level <application> node.
2. Copy and paste or enter the complete <mailSettings> definition, as in the following example. You
can include the code comments.
<application id="yourProjectLayer">
<description>yourProjectLayer</description>
<buildTargets />
<database>
<driver>SQLSERVER</driver>
<sqlsyntax>SQLSERVER</sqlsyntax>
<connectString>Network Library=DBMSSOCN;Data Source=localhost,1433;Initial
Catalog=DbName;
User ID=yourUserID;Password=yourPassword;Application Name=AVM</connectString>
<connectStringForSsas>[Connection string that allows SSAS to connect to Avocet DB]
</connectStringForSsas>
</database>
<mailSettings>
<!-- For details, see http://msdn.microsoft.com/en-us/library/ms164240(v=vs.110).aspx -->
<smtp from="[Specify the from address for outgoing e-mails]">
<network host="[Specify the hostname of the SMTP mail server to use for SMTP transactions]"
/>
<!-- Optional parameters, see:
http://msdn.microsoft.com/en-us/library/ms164242(v=vs.110).aspx
defaultCredentials="Specifies whether the default user credentials should be used
to access the SMTP mail server for SMTP transactions. The default value is false."
enableSsl="Specifies whether SSL is used to access an SMTP mail server.
The default value is false."
password="Specifies the password to use for authentication to the SMTP mail server.
This attribute has no default value."
port="Specifies the port number to use to connect to the SMTP mail server.
The default value is 25."
targetName="Specifies the Service Provider Name (SPN) to use for authentication

64 Avocet Installation Reference

 when using extended protection for SMTP transactions. This attribute has no
default value."
userName="Specifies the user name to use for authentication to the SMTP mail server.
This attribute has no default value."
-->
</smtp>
</mailSettings>

3. Save your appConfig_ projectLayer file.

4. If you are creating a new application instance, open the
implementationFolder/AvocetVM/Config/appInitConfig.xml file.
5. Under the <application id="ConfigTemplate"hidden="true"> node, verify that the <mailSettings>
definition exists.
<mailSettings>
<!-- For details, see http://msdn.microsoft.com/en-us/library/ms164240(v=vs.110).aspx -->
<smtp from="[Specify the from address for outgoing e-mails]">
<network host="[Specify the hostname of the SMTP mail server to use for SMTP transactions]"
/>
<!-- Optional parameters, see:
http://msdn.microsoft.com/en-us/library/ms164242(v=vs.110).aspx
defaultCredentials="Specifies whether the default user credentials should be used
to access the SMTP mail server for SMTP transactions. The default value is false."
enableSsl="Specifies whether SSL is used to access an SMTP mail server.
The default value is false."
password="Specifies the password to use for authentication to the SMTP mail server.
This attribute has no default value."
port="Specifies the port number to use to connect to the SMTP mail server.
The default value is 25."
targetName="Specifies the Service Provider Name (SPN) to use for authentication
when using extended protection for SMTP transactions. This attribute has no
default value."
userName="Specifies the user name to use for authentication to the SMTP mail server.
This attribute has no default value."
-->
</smtp>
</mailSettings>
</application>

6. Save your appInitConfig.xml file.

7. Restart your Avocet instance and any related OPC UA services to initialize the change.

65