0% found this document useful (0 votes)
686 views52 pages

Avocet Production Data Management System Installation Guide

This document provides instructions for installing the Avocet Production Data Management System components using the Avocet Installer utility. It discusses installing Avocet, the ClickOnce client, the application server, licensing software, and optional plug-ins. It also covers prerequisites, supported operating systems, database servers, troubleshooting, and post-installation considerations.

Uploaded by

boualem.ini
Copyright
© © All Rights Reserved
We take content rights seriously. If you suspect this is your content, claim it here.
Available Formats
Download as PDF, TXT or read online on Scribd
0% found this document useful (0 votes)
686 views52 pages

Avocet Production Data Management System Installation Guide

This document provides instructions for installing the Avocet Production Data Management System components using the Avocet Installer utility. It discusses installing Avocet, the ClickOnce client, the application server, licensing software, and optional plug-ins. It also covers prerequisites, supported operating systems, database servers, troubleshooting, and post-installation considerations.

Uploaded by

boualem.ini
Copyright
© © All Rights Reserved
We take content rights seriously. If you suspect this is your content, claim it here.
Available Formats
Download as PDF, TXT or read online on Scribd
You are on page 1/ 52

Avocet Production Data Management

System Installation Guide


Contents
Avocet Production Data Management System Installation Guide.............................3
Avocet installation preliminaries and references...........................................................................................3
Supported operating systems, servers, and databases for Avocet desktop ................................................4
Avocet 2017.2 components..........................................................................................................................7
Avocet 2017.2 installation packages.............................................................................................................8
Avocet 2017.2 licensing................................................................................................................................8
Common prerequisites for Avocet desktop...................................................................................................8
Avocet Installer utility..................................................................................................................................11
Upgrade prerequisites.................................................................................................................................12
Files to download........................................................................................................................................12
Before launching the Avocet Installer..........................................................................................................13
Launch the Avocet Installer.........................................................................................................................14
Install the licensing software.......................................................................................................................16
Install Avocet...............................................................................................................................................20
Microsoft ClickOnce....................................................................................................................................32
Install the AppServer..................................................................................................................................45
Install Petrel Studio Plug-in 2015................................................................................................................45
Install OFM Plug-in 2014.1, 2016.1, or 2016.2...........................................................................................46
Troubleshooting installation issues.............................................................................................................46
Post-installation considerations..................................................................................................................48
Production day start....................................................................................................................................49
Specify a timeout interval for the Avocet client...........................................................................................50
Define links to custom screen-level help files.............................................................................................51
Enable custom screen-level help on an existing database implementation................................................52

ii Avocet Production Data Management System Installation Guide


Avocet Production Data Management
System Installation Guide
This section discusses how to install the Avocet Production Data Management System (PDMS)
components through the Avocet Installer utility.
The Avocet PDMS components include the following:
• Avocet
• ClickOnce for Avocet client
• Avocet application server
In addition, the Avocet Installer offers the following options:
• Schlumberger Licensing software
• Petrel Studio Plug-in 2015
• OFM Plug-in 2014.1, OFM Plug-in 2016.1, and OFM Plug-in 2016.2

Avocet installation preliminaries and references


This section introduces the Avocet prerequisites and lists supplemental information that is helpful to
the configuration and deployment of certain Avocet components.

Note: To start installing Avocet components immediately, without reviewing preliminaries and
prerequisites, skip to the Avocet Installer utility section.

To complete the setup and configuration of some of the components, refer to the following Help topics
and documents:

Help topic Description

Installation Reference Provides guidelines for MS SQL server and Oracle database setup

Supplies a deployment overview

Summarizes upgrade scenarios

Application Servers and Process Groups Contains configuration steps for setting up Internet Information Services server
to support the Avocet web services API and the application server

Avocet Integration: Studio Contains installation and configuration information for the Petrel Studio Plug-in
2015

Avocet Integration: Oilfield Manager Projects Contains installation and configuration information for the OFM Plug-in 2014.1,
2016.1, and 2016.2

The Avocet Installer does not deploy the Avocet web services independently
Avocet Web Services
as its own package because the web services package is designed mainly for
developers. Refer to the Avocet Web Services documentation for configuration
details.

3
Supported operating systems, servers, and databases for Avocet desktop
This topic summarizes the client and server operating systems and the databases that Avocet 2017.2
supports for the Avocet desktop.

Supported Client OS

Windows 7 SP1 64-bit, Professional and Enterprise editions

Windows 10 64-bit, Professional and Enterprise editions

Supported Server OS

Windows Server 2012 R2 64-bit

Supported database server

Oracle 12.1.0.2 (Oracle 12c) Enterprise

MS SQL Server 2012 SP2 Standard

The Enterprise editions of the database servers support features such as database partitioning and
compression. The Standard editions do not support these features though they do support all Avocet
functionality. When sizing your database, if the Enterprise features are not required, you can use the
Standard edition.

Note: While the Enterprise edition of MS SQL Server 2012 SP2 has not been formally certified,
it is used in test and production deployments.

As a rule of thumb, you should also use the most recent release of the database server.
The following SQL database engine has been tested for disconnected desktops:
• SQLite v.3.7.17
SQLite is specifically aimed at local installations on disconnected field laptops having single users. Its
requirements are minimal.
The following IIS versions are supported for the web services API:
• IIS 8.0 or 8.5 on Windows server 2012 R2

Client workstation requirements


This topic contains a table that shows the recommendations for the client workstations that connect
Avocet to its database. The recommendations cover the operating system, processor, physical memory,
and so on.

Requirement Minimum Size Recommended Size

Operating System Microsoft Windows 7 SP1 64-bit Microsoft Windows 7 SP1 64-bit

Processor Intel i3 or equivalent Intel i7 or later

Physical Memory 2 GB 8 GB or greater

Hard Disk Space 2 GB 20 GB or greater

Display 17-in monitor (1280 x 1024) 21-in monitor (1920 x 1080)

4 Avocet Production Data Management System Installation Guide


Requirement Minimum Size Recommended Size

Client software Microsoft .NET 4.6.1 Runtime, Microsoft Internet Explorer 8 or later

Microsoft Office 2003 or higher required for integration for Office applications

Database connectivity Required for client machines connecting directly to the database (client/server mode).

SQL Server client software is included with Microsoft Vista or later. SQL Server client software
matching the database server version is recommended.

Oracle Instant Client software is included with the application. Oracle client software deployed
on machines is also supported.

Database server guidelines


This topic contains a table that shows the recommended guidelines for database servers, such as
operating system, processor, and so on.

Note: The requirements and recommendations described herein are guidelines. They may vary
depending on your specific deployment requirements.

Database server specifications will change based on anticipated data requirements and user load.
Specifications here indicate typical configurations. At a minimum, data and indexes should be separated
on two physical disks with their own disk controllers.
The database server can be deployed using vendor-specific high availability solutions for redundancy
and disaster recovery. Proper back-up procedures should be used to provide protection against failures
based on standard IT procedures.

Note: Beginning with Windows Server version 2008 R2, all Windows Server versions are
released in 64-bit only.

Requirement Recommended Size Recommended Size

(Smaller asset) (Larger asset)

Operating System Microsoft Windows Server Microsoft Windows Server 2012 R2


2012 R2

Processor 2 Intel Dual x64 Server class 4 Intel Dual x64 Server class CPUs or better
CPUs or better

Physical Memory 8-16 GB 32-128 GB

Hard Disk Space 2 x 500 GB or greater The database sizing varies by client.

Display 17” monitor (1024 X 768)

Database software Recommended: Microsoft SQL Server 2012 SP2 Standard Edition or Oracle 12.1.0.2
(Oracle 12c) Enterprise Edition

Following your Oracle or MS SQL Server guidelines, you can install and run the database on any
compatible database server.

Application server requirements


This topic contains a table that shows the recommended application server requirements such as
operating system, processor, physical memory, and so on.

5
Application server requirements change based on anticipated user load.
For example, the hard disk space values in the following table assume that a single machine contains
the application, replication, and web servers and that the client intends to store months of replication
data.
The sizing values always vary with the client's business requirements. As always, try to determine the
scale before deploying Avocet.

Requirement Minimum Size Recommended Size

Operating System Microsoft Windows Server Microsoft Windows Server 2012 R2 x64
2012 R2 x64

Processor Intel Core, AMD Opteron, or 2 Intel Dual x64 Server class CPUs or better
equivalent

Physical Memory 16 GB 32-64 GB

Hard Disk Space 1 TB 2 x 1 TB or greater

Display 17” monitor (1024 X 768)

Server software Microsoft .NET 4.5.2 Runtime, Microsoft Internet Explorer 8 or later

Microsoft Office 2003 or higher required for integration for Office applications

Database connectivity Required for client machines connecting directly to the database (client/server mode).

SQL Server client software is included with Microsoft Vista or later. SQL Server client software
matching the database server version is recommended.

Oracle Instant Client software is included with the application. Oracle client software deployed
on machines is also supported.

Avocet as a published application through Citrix or Microsoft technologies


Avocet can be deployed on Citrix Presentation Server, Citrix XenApp, or Windows Terminal Server
through an xcopy deployment on a published endpoint.

Server requirements for delivering Avocet as a published application


This topic contains a table that lists the requirements for delivering Avocet as a published application.
The information includes operating system, processor, physical memory, hard disk space, and so on.

Requirement Minimum Size Recommended Size

Operating System Microsoft Windows Server 2012 R2 64-bit Microsoft Windows Server 2012 R2 64-bit

Processor Intel Dual, Quad, or 8-Way Server class Intel Dual, Quad, or 8-Way Server class CPU’s
CPUs or better or better

Physical Memory 16-32 GB 32-128 GB

Hard Disk Space 50 GB or greater 50 GB or greater

Display 17” monitor (1280 x 1024) 21-in monitor (1920 x 1080)

Server software Microsoft .NET 4.6.1 Runtime, Microsoft Internet Explorer 8 or later

Microsoft Office 2003 or higher required for integration for Office applications

6 Avocet Production Data Management System Installation Guide


Requirement Minimum Size Recommended Size

Database connectivity Required for client machines connecting directly to the database (client/server mode).

SQL Server client software is included with Microsoft Windows Vista or later. SQL Server
client software matching the database server version is recommended.

Oracle Instant Client software is included with the application. Oracle client software deployed
on machines is also supported.

Client requirements for consuming Avocet as a published application


This topic discusses the client requirements for consuming Avocet as a published application.
Hardware requirements vary based on the operating system selected for Citrix Presentation Server
or Windows Terminal Services clients.
Citrix supports a variety of operating systems including UNIX, Macintosh, Linux, Microsoft DOS,
Windows, and Windows CE. Contact Citrix for more information.
Microsoft supports a variety of operating systems including Mac and various Windows versions. Contact
Microsoft for more information.

Microsoft Visual Studio


Because Microsoft .NET 4.6.1 Runtime is a prerequisite that the Installer provides, you should use a
compatible version of Microsoft Visual Studio as your preferred editor: for example, Microsoft Visual
Studio 2015.

Avocet 2017.2 components


This topic contains a table that describes the main software components in the Avocet 2017.2 installation
package.

Component Description

Avocet desktop client The main client GUI where you perform your production management tasks

Configuration Tool Utility that allows administrators to initialize databases, modify the type system, set up units
of measure, and perform a range of administrative tasks

Database Configuration Tool Utility that allows administrators to create and initialize fresh database instances and upgrade
existing database with the latest data type definitions

AvocetWebService The web services API is addressed to developers to customize and extend their own web
services applications. It does not have its own installation routine. See the Avocet Web
Services documentation in the AvocetVM\Documentation folder.

Note: The Avocet web services API is required for the Avocet application server
deployment and is installed with the application server.

ClickOnce Deployment package that enables an Avocet server to publish files to multiple Avocet clients,
providing for the installation and updating of Avocet clients through a web connection

Application server A server that is especially designed to handle the execution of Avocet processes, such as
allocations and data loading. It requires the Avocet web services API and an Internet
Information Services (IIS) server.

7
Component Description

Redistributables Avocet includes several redistributables, such as Microsoft Visual C++ Redistributable for
Visual Studio 2015, .NET Framework 4.6.1, Visual C++ Runtime, Report Viewer, and others.

Plugins Studio and OFM plugins are available for connecting Avocet with Studio and OFM

Avocet 2017.2 installation packages


Avocet 2017.2 components are contained in three zipped files that you can download from the SIS
Software Download Center. This topic lists the three files (installation packages) and explains what is
in each.
The installation package is available at SIS Software Download Center.

Installation package Description

Avocet_2017.2_Full_Release.zip Contains the Avocet implementation folders AvocetVM,


AvocetWebService, and AppServer

Avocet_2017.2_InstallationUtility.zip A Windows PowerShell utility from which you can install Avocet
prerequisites and components, including the ClickOnce
deployment package and Studio and OFM plug-ins

Avocet_2017.2_Prerequisites.zip A convenience zipped package that contains the Avocet


prerequisite components

Avocet 2017.2 licensing


Avocet 2017.2 requires an Avocet date-based version (DBV) license file that is current at the time of
its commercial release.
The client maintenance expiration date is included in the feature line of your license. For example,
2017.09 indicates that your license expires in September, 2017. If you are under a current maintenance
contract and intend to use existing features, you can run Avocet 2017.2 using your existing license.
However, if you intend to use new features, such as the web services API, you need to renew your
license.
You can view your license features in your Avocet installation by selecting File > About and clicking
the Licensed Modules tab in the About Avocet dialog. Internal users can view the following license
grid on the Hub:
• licensing grids
For additional licensing requirements, contact your Avocet business development manager.
Avocet 2017.2 uses FlexLM version 11.14 or later from MacroVision for concurrent licensing. Daemons
are available for both Microsoft Windows and UNIX operating systems.
If your Avocet 2017.2 installation uses a license server (portNumber@serverName), then you must
use Schlumberger Licensing Tool 2017.1, which includes the FLexLM 11.14 license.You can download
the Schlumberger Licensing Tool 2017.1 from the SIS Software Download Center. You can enter the
search criteria “Schlumberger licensing.”

Common prerequisites for Avocet desktop


The Avocet desktop version requires several runtime and redistributable files.

8 Avocet Production Data Management System Installation Guide


Windows Powershell 3.0 or later is required by the Avocet Installer utility and for executing certain
post-install scripts. You must already have Windows Powershell 3.0 or later already deployed before
you can successfully launch the Avocet Installer utility.
Aside from Windows Powershell, the Avocet Installer utility checks for other prerequisites and installs
missing prerequisites after you acknowledge a prompt.
The Avocet desktop requires the following prerequisite runtime and redistributable files:
• Microsoft Visual C++ Redistributable for Visual Studio 2015
• Microsoft .NET Framework 4.6.1 or later
• Microsoft ReportViewer 2010 Redistributable
• Microsoft ReportViewer 2012 Redistributable
• Microsoft Visual C++ 2008 Runtime Libraries (x64)
• Microsoft Visual C++ 2008 Runtime Libraries (x86)
• Microsoft Visual C++ 2010 Runtime Libraries (x64)
• Microsoft Visual C++ 2010 Runtime Libraries (x86)
• Microsoft Visual C++ 2012 Runtime Libraries (x64)
• Microsoft Visual C++ 2012 Runtime Libraries (x86)
• Microsoft Access Database Engine Redistributable 2010
• Windows Powershell 3.0 or later
Depending on your OS, you may already have at least some of the prerequisites installed. To check
which prerequisites you have, you can view the listing of installed programs in the Control Panel’s
Program and Features window.
To execute some of the configuration and verification commands, you should have the administrator
privilege or be able to run tasks as the administrator.

Check file versions through Windows registry


If you have administrative privilege, you can check the Windows registry for updates by running the
regedit command.
This example shows how to check the .NET framework version through Registry Editor.

1. Launch the regedit.exe command.


2. In the Registry Editor, open the following subkey:
HKEY_LOCAL_MACHINE\SOFTWARE\Wow6432Node\Microsoft\Update
You can view .NET Framework and redistributable entries, as shown in this example:

You can either refer to the corresponding Microsoft websites for downloading and verifying the
installation of the components or run the Avocet Installer utility.

9
Run PowerShell with administrator privileges for Windows 8
This task shows how to modify the Windows PowerShell so it always runs with administrator privileges.
Thereby you do not have to select Run as Administrator even if you are already an administrator on
the system.
On a Windows 8 system, when launching the PowerShell window you may get an error when running
the script. To run the script successfully, you have to select Run as Administrator even if you are
the administrator on the system. To avoid this extra step, you can modify the Windows PowerShell
shortcut so that it always runs with the administrator privilege.

1. Right-click the Windows PowerShell shortcut to display the flyout menu, and choose Properties.

2. In the Shortcut tab of the Windows PowerShell Properties dialog, choose Advanced… .
3. In the Advanced Properties pop-up, select the Run as administrator check box.

10 Avocet Production Data Management System Installation Guide


4. Click OK to close the Advanced Properties pop-up.
5. Click Apply in the Windows PowerShell Properties dialog, and then click OK.

Avocet Installer utility


This section lists the tested and supported Avocet Installer utility platforms. It also shows how to install
the various Avocet components and third-party utilities using the Avocet Installer utility.
You can use the Avocet Installer utility for both single and multiple system installations. The utility
includes the prerequisites.
The Avocet Installer utility is supported on
• Window server 2008 R2
• Windows server 2012 R2
The Avocet Installer utility also runs on supported Windows client versions, but not all installation
routines are supported on the Windows clients. For example, you cannot install the application server
on Windows clients.

11
Note: The Avocet web services API is installed as part of the application server installation. It
does not have its own installation routine. You must manually deploy the web services API if
you want to use it to extend or customize web applications other than the application server.

Upgrade prerequisites
This procedure provides guidelines for what you must do if you have an existing implementation that
you are upgrading.
Before upgrading any aspect of Avocet, do the following:

1. Save ALL customized files.


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 Avocet files, so be sure to copy them as well.
2. If you have customized scripts, DLLs, or configuration files, be sure to copy and save them.

Files to download
This task lists which files to download and then shows how to download them from the Schlumberger
Integrated Solutions (SIS) Software Download Center.
From the Schlumberger Integrated Solutions (SIS) Software Download Center (SIS Software Download
Center), download the following zipped files:

• Avocet_2017.2_Full_Release.zip
This contains the Avocet content folders AvocetVM, AvocetWebService, and AppServer.
• Avocet_2017.2_InstallationUtility.zip
This contains the Avocet Installer components, including prerequisites and utilities.
• Avocet_2017.2_Prerequisites.zip
A convenience package, this zipped file contains the Avocet prerequisites, also contained in the
Avocet_2017.2_InstallationUtility.zip file. You can copy this package to multiple machines to lay
down the Avocet prerequisites.

Downloading the Files

1. Log into the SIS Software Download Center by selecting


https://www.sdc.oilfield.slb.com/SIS/Login.aspx.
2. Review and accept the terms of usage agreement if you have not done so already.
3. Review any updates at the Welcome Message page, and click Continue to display the Software
Download Center main page.
4. Under Product Group Name, select Production. Then under the Product List\ Product Name
category, select Avocet Operations Technologies to display the available downloads.
5. Select the zipped file or files to download, and click Download.

12 Avocet Production Data Management System Installation Guide


The File Download Manager window opens. The download may start automatically. Otherwise,
follow the prompts, and set your download folder to a temporary location.

Before launching the Avocet Installer


This task shows the steps that you need to complete before you can launch the utility.
Be sure to save all custom configuration files to a separate folder so that they are not overwritten.
Download or obtain the Avocet_2017.2_Full_Release.zip file, and extract the Avocet content folders
to a temporary location.
Download or obtain the zipped Installer package from a secure location and copy it to your local drive
and temporary folder.

1. Extract the contents of the zipped Installer package to the temporary folder.
The file contents, which are contained in a single Installer folder, are displayed below:.

2. Copy the Avocet content folders you extracted from the Avocet_2017.2_Full_Release.zip file to
the Avocet subfolder that resides within the Installer folder.
The Installer\Avocet subfolder should display the contents as shown in the following screenshot:

3. Paste your customized Avocet files to their respective subfolders in the Installer folder.
4. Optional. After you copy the Avocet content folders to the Avocet subfolder, you can copy and
move the Installer folder to different supported systems to install different components.

13
The following diagram outlines how the Avocet Installer deploys the Avocet content folders to a
specified deployment folder:

Launch the Avocet Installer


This task shows how to launch the installer.
To run the installation scripts, you will need PowerShell 3.0 or later.

1. Double-click InstallerUI.bat to launch the Avocet Installer utility.


By default, all standard options are selected.

14 Avocet Production Data Management System Installation Guide


2. Review the description of the installation options before launching any install routine.
CAUTION: The Avocet HF Store and Avocet HFI Manager installation options are NOT supported.
Do NOT install them.
3. Before clicking Install to launch an install routine, consider the following:
• The routine prompts you before installing any missing prerequisites. If you choose not to install
the prerequisite, the installation routine exits.
• The Schlumberger Licensing Software selection is installed in predefined folders, ignoring the
browse path specified under Deployment location.
• You must select the Terms & Conditions acceptance and the safety acknowledgment before the
Install option is enabled.
• If the installation routine encounters any error, the install stops at that point.

About the installation options


This topic summarizes the different installation options presented by the Installer and indicates which
ones require additional configuration after the installation is complete.
The Avocet Installer selections are shown below:

15
Option Description Additional configuration

Avocet the AvocetVM folder and contents The Installer checks for and prompts you to install
any missing prerequisites, including
• Microsoft Visual C++ Redistributable for Visual
Studio 2015
• Microsoft .NET Framework 4.6.1 or later
• Microsoft ReportViewer 2010 Redistributable
• Microsoft ReportViewer 2012 Redistributable
• Microsoft Visual C++ 2008 Runtime Libraries (x64)
• Microsoft Visual C++ 2008 Runtime Libraries (x86)
• Microsoft Visual C++ 2010 Runtime Libraries (x64)
• Microsoft Visual C++ 2010 Runtime Libraries (x86)
• Microsoft Visual C++ 2012 Runtime Libraries (x64)
• Microsoft Visual C++ 2012 Runtime Libraries (x86)
• Microsoft Access Database Engine Redistributable
2010

ClickOnce for the ClickOnce deployment package Setup instructions are described herein.
AvocetClient

Avocet AppServer the Avocet application server, including the The Avocet application server requires Windows
scheduler process.The application server manages server 2012 R2. After installing the application server,
resource-intensive processes such as data loading, refer to the Help topic Application servers and
allocations, and so forth. These processes can be process groups for setup and configuration
served on separate systems, apart from the system instructions.
where the Avocet client resides.

Schlumberger This is the 2017.1 version of the Schlumberger You manually configure the license utility after it is
Licensing Software Licensing utility. The Installer deploys it in its installed.
default location, ignoring the value in the
Deployment location field.

Studio and OFM The Studio plug-in is an integration component that If necessary, you can copy the extracted folder to
plug-ins lets you load Avocet well bore and completion the target systems. Each plugin utility folder contains
items into Petrel for analysis.The two OFM plug-ins an MSI installer file. You manually launch the MSI
enable the export of forecast data from OFM to file to install the plugin. Refer to the Help topics
Avocet. You can install both OFM plug-ins on the Avocet Integration: Studio and Avocet Integration:
same system if you have the corresponding OFM OFM.
versions installed. Each plugin folder is extracted
to the path specified in the Deployment location
field.

Deployment the file path for installing the selected options. The
location Installer does not read the Deployment location
value for the Schlumberger Licensing and plug-in
selections.

Terms and You must acknowledge both statements by


Conditions and selecting their check boxes.
Safety Critical
statements

Install the licensing software


This section discusses how to install the local license file and how to set up licensing on the server.
This particular topic provides an overview of the steps and some tips on configuring the server.
Subsequent topics provide step-by-step instructions.
The licensing software option launches a separate InstallShield wizard for Schlumberger Licensing
2017.1. Follow the on-screen instructions. You can accept the default selections.
As a result of a successful installation, a Schlumberger Licensing menu option is created in the Start
menu tree under the Schlumberger folder: Schlumberger Licensing 2017.1.

16 Avocet Production Data Management System Installation Guide


The install script generates an output message denoting the status of the license installation:

You can launch the Schlumberger Licensing window:

Installing and configuring your license


To install and configure your license, review the Schlumberger Licensing User Guide that you can
access from the Help menu in the Schlumberger Licensing window.
As an example, to set a remote license server, enter the port number and fully qualified domain name
under Remote License Servers text box. Then click Add license server.

17
Be sure that your user and system variables are entered correctly. This will depend on the type of
license that you have selected.
As an example, the port number and domain name are entered as both user and system variables in
the Environment Variables dialog under the Advanced tab of your computer’s System Properties
definition.

Schlumberger Licensing can run on your local machine or on a license server. Therefore, use one of
the following workflows:
• To use a local license file, install and set up Schlumberger Licensing on your local machine.
• To use a server license file, install and set up Schlumberger Licensing on your licensing server
machine and on your local machine.

Set up a local license file


This task shows how to set up licensing with a local license file.

1. Save the license file to any folder on your local machine.


2. Choose Start > Programs > Schlumberger > Schlumberger Licensing nnnn.n >
Schlumberger Licensing.
The Schlumberger Licensing window opens.
3. Click Stop in the Local License Server section.

18 Avocet Production Data Management System Installation Guide


The license server stops.
4. Click Add License File.
The Open dialog opens.
5. Browse to the folder where you saved the license file.
6. Select the file and click Open.
7. Click Start.
A confirmation dialog box opens.
8. Click Apply.
9. Click OK to close the Schlumberger Licensing window.

Set up a licensing server


This task shows how to install setup the licensing server and then connect that server to your local
machine.
License server machine tasks
Perform these steps on the license server machine.

1. Save the license file to any folder.


2. Select Start > Programs > Schlumberger > Schlumberger Licensing 2017.1 > Schlumberger
Licensing from your Start menu.
The Schlumberger Licensing window opens.
3. Click Stop in the Local License Server section.
The license server stops.
4. Click Add License File.
The Open dialog opens.
5. Browse to the folder where you saved the license file.
6. Select the file and click Open.
7. Click Start.
A confirmation dialog opens.
8. Click Apply.
9. Click OK to close the Schlumberger Licensing window.

Local machine tasks


Perform the following steps on your local machine:

1. Choose Start > Programs > Schlumberger > Schlumberger Licensing 2017.1 > Schlumberger
Licensing from your Start menu.
The Schlumberger Licensing window opens.
2. Enter your license server name in the All License Servers section, and then click Add License
Server.
3. Click Apply.
4. Click OK to close the Schlumberger Licensing window.

19
Install Avocet
This set of tasks shows how to install Avocet from the Installer, launch Avocet for the first time, and
prepare your new or existing database.

1. To deploy the AvocetVM folder to the target directory specified under Deployment location, do the
following:
a) Select Avocet.
b) Verify the deployment location.
c) Select the Terms & Conditions and safety acknowledgement check boxes.
d) Click Install.
Windows Powershell is displayed. You are prompted to install any prerequisites. If the deployment
is successful, you receive a message saying that the setup is finished and specifying the location
of the log file. You are returned to the directory path of the Installer folder.
The Avocet Installer should copy your customized files to their respective folders.
2. Verify that your customized files were successfully deployed to their respective folders.
3. Exit Windows Powershell by typing Exit at the directory prompt.

Initialize a fresh database


This task shows how to initialize a fresh database instance for your Avocet implementation.
Define your fresh database schema in Microsoft SQL Server or Oracle.
Refer to the Help topic Installation Reference for database setup guidelines.
You typically create and initialize a fresh database if this a first-time installation. If you are upgrading
from an earlier version of Avocet, you typically upgrade and initialize an existing database. Refer to
the Help topic Initialize an existing database.

1. Launch the Database Configuration Tools utility (DatabaseConfigTools.exe) from your


installationDirectory\AvocetVM\config folder.
2. In the Navigation Tree, click Application Initializer to open the Application Initializer screen.
3. Select the data source, and specify the connection string, as in the MS SQL Server example shown
below that uses SQL Server authentication:

20 Avocet Production Data Management System Installation Guide


Note: You can choose to use Windows authentication in your connection string, provided
you have enabled it on your database server.

4. Click Next to go to the application options.


5. Specify the Implementation Name and Application ID values.
Although you can enter different values for each, to make a first-time implementation easier, enter
the same value for both the Implementation Name and Application ID fields.
6. Click the Add Layer drop-down list, make your layer selections, and click Add to add them to the
Layers list.
7. Verify the other selections.
8. Click Finish to initialize the fresh database.
The corresponding configuration files are generated under the installationDirectory\AvocetVM\config
file path:
• AppConfig_ ImplementationName .xml
• vmConfig_ ImplementationName .xml
• CustomNavigators_ ImplementationName .xml
• GridReports_ ImplementationName .xml
• TransactionDataGridConfig_ ImplementationName .xml
• TransactionRollupConfig_ ImplementationName .xml
The ImplementationName .xml layer file is stored under installationDirectory\AvocetVM\config\layer.
9. Verify that the layer hierarchy is maintained in your AppConfig_ ImplementationName .xml file,
as in this example:
• <layers>
<layer>AVM</layer>
<layer>UnitSystem_Imperial</layer>
<layer>OG_STD</layer>
<layer>HF</layer>
<layer>YourImplementationLayer</layer>
</layers>

• Check that the corresponding vmConfig_layerName.xml extensions are listed, as in this


example:
<vmConfig id="YourImplementationLayer">
<base>vmConfigBase.xml</base>
<extension>vmConfig_OG_STD.xml</extension>
<extension>vmConfig_HF.xml</extension>
<extension>vmConfig_YourImplementationLayer.xml</extension>
</vmConfig>

Proceed to generate replication triggers for your database instance if you intend to use the Avocet
replication scenarios.
Windows authentication and connection string syntax
Microsoft recommends using Windows authentication to connect to your database server.
If you choose Windows authentication as your connection method, you must first ensure that the
Windows authentication user account is defined on your database server. For example, in MS SQL
Server you can launch Microsoft SQL Server Management Studio, connect to your database server,
and verify the Windows user account under the Security > Logins subfolder:

21
You must include an Integrated Security attribute (or Trusted_Connection depending on your data
provider) in your connection string. You can refer to the following table, which is described in this
MSDN web page.

Data provider Connection string syntax attribute

SqlClient Integrated Security=true;


or
Integrated Security=SSPI;

Note: Integrated Security=SSPI; is recommended because Integrated Security=true;


generates an exception error when used with an OleDB provider.

OracleClient Integrated Security=yes;

OleDb
Integrated Security=SSPI;

Odbc Trusted_Connection=yes;

When constructing your connection string using Windows authentication, you can omit the user name
and password.
The following example shows an MS SQL server database connection string for Windows authentication:
<connectString>Network Library=DBMSSOCN;Data Source=DatabaseServer,1433;
Initial Catalog=DatabaseName;Integrated Security=SSPI;Application Name=AVM</connectString>
The next example shows an Oracle database connection string for Windows authentication:
<connectString>Data Source=MyOracleDB:1521;Integrated Security=yes;</connectString>

How to upgrade from Avocet 2014.1.n to Avocet 2017.1


This upgrade section assumes that you have an existing database that you wish to upgrade.
If you want to create a fresh database, see the topic Initialize a fresh database.

Note: If upgrading from an earlier Avocet version, refer to the Help topic Avocet upgrade
scenarios in the Installation Reference section.

Initialize an existing database


For an existing database, this section discusses how to execute the Upgrade Manager, upgrade to
the latest data types, and remove references to deprecated features.
To ensure that your existing database is up to date and compatible with the latest 2017.2 Avocet
implementation, you
• run Upgrade Manager to upgrade the database schema
• initialize the upgraded database with the latest type information
• remove references to deprecated features
• generate replication triggers if you have not already done so

22 Avocet Production Data Management System Installation Guide


Execute the Upgrade Manager
This topic discusses running the Avocet Upgrade Manager when you update an existing database so
that you can verify that you have the latest database scripts.
The Database Configuration Tools utility (DatabaseConfigTools.exe) offers the Upgrade Manager
feature. It 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
• 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. You can run the scripts multiple times across upgrade sessions without
them failing the initialization process.

Note: If you are upgrading from Avocet 2012.1 or Avocet 2012.1 SP 1, you have to first execute
specified preliminary upgrade scripts before continuing to the formal database upgrade. Refer
to the Help topic "Database upgrade from Avocet 2012.1 or Avocet 2012.1 SP 1" in the Installation
Reference section for more information.

Perform script upgrades

23
This task shows how to perform a script upgrade and how to tell if the script ran successfully, failed,
or was not run.

1. In the implementationFolder\AvocetVM folder, 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 to connect to.
The application Id references the database you want to upgrade.
The Upgrade Manager displays the corresponding scripts having the updates that you can apply
to the target database. All scripts are selected by default.

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.

24 Avocet Production Data Management System Installation Guide


5. In the ribbon toolbar, click Home > Upgrade 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 selected script fails the upgrade, it is noted with an X mark against a red background, as
shown in this example taken from a different upgrade session:

You can click on the X to view the accompanying error message. An example error message is
shown below:

25
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

26 Avocet Production Data Management System Installation Guide


• failed
• not run

Show applied updates


This task shows how you can view the scripts that have run successfully against a database or that
have been designated Never Run and have been excluded from the upgraded list.

1. In the Upgrade Manager, select an application Id (database) from the database drop-down list.
2. Click Home > Show Applied Updates in the ribbon toolbar.
The scripts that have been executed against the database or that have been designated Never
Run are listed in the left-hand panel, as shown in this example:

27
Any upgrade or other action does not affect the scripts that have already been applied to the
database.
3. Deselect Show Applied Updates to return to the list of available upgrade scripts.

Never Run

28 Avocet Production Data Management System Installation Guide


This task shows how to designate scripts that you do not want 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.

Note: Be careful which script or scripts you designate as Never Run because they are removed
from the list of available upgrade scripts for the application ID.

To mark a script as Never Run, do the following:

1. In the list of scripts to upgrade, select the script you do not want to execute against the application
ID.
2. In the ribbon toolbar, choose Home > Never Run.
The script designated Never Run is removed from the list of scripts to upgrade for the specific
application ID and database. When you select Home > Show Applied Updates, the Never Run
script is displayed at the bottom of the list of scripts that have been applied to the database.
3. For future reference, note the script or scripts that you have designated as Never Run.
4. If in a later upgrade session you decide to run the upgrade script, do the following:
a) Choose Home > Show Applied Updates, and scroll to the upgrade script you designated as
Never Run.
b) Select the script, and click Home > Upgrade.
The script is executed against the database. In the status list on the right-hand panel, scroll to the
bottom of the list to verify that the script upgrade was successful.

Troubleshooting: query for upgrade scripts


You can use a SQL query to search your database for upgrade scripts. For the upgrade to succeed,
be mindful that column names in each table must be unique.
Each upgrade script is identified in the database VERSION table by the type DB_UPG_VER (database
upgrade version), with each script having its unique version string identifier. You can use the following
SQL database query to search for the upgrade scripts in the database: SELECT * FROM VERSION
WHERE VER_TYPE = 'DB_UPG_VER'. The query result looks similar to the following example:

Some script upgrades can fail because of errors similar to the following:
• 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 types 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.
Initialize the existing database with the latest definitions from the type system
This task shows how to initialize your existing database with the latest definitions from the type system.

1. Launch the Avocet Configuration Tools utility (configTools.exe).

29
2. Log into your application ID.
3. Access the Database Initializer screen (Database Tools > Database Initializer).
4. Verify that the layers you want to initialize are marked for import.

5. Select Home > Tools > Initialize.


The corresponding configuration files are generated.

After initializing your database with the latest type definitions, you should
• remove references to deprecated features
• generate replication triggers if you haven't done so
Remove references to deprecated features
Upgrade users must delete certain configuration files and remove tags that point to deprecated features.
Effective Avocet 2017.1 onwards, 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

30 Avocet Production Data Management System Installation Guide


Generate replication triggers
This task shows how to generate replication triggers so that Avocet database can receive updates
from field databases in Avocet replication scenarios.
To generate replication triggers, follow these steps:

1. Open the Avocet Configuration Tools utility (ConfigTools.exe), and in the Navigation Tree, access
Replication > Trigger Manager to open the Trigger Manager screen.
2. Check whether the Home > Replication Triggers > Create Publisher Database option is enabled.
If it is greyed out, go to step 3. Otherwise, click Create Publisher Database.
The publisher database is created.
3. Click Create Replication Triggers to generate the SQL Server replication triggers, as shown in
this screen excerpt:

Launch the Avocet executable for the first time


For each Avocet version, when you first launch an Avocet executable that requires you to log into a
database, you must accept the Terms and Conditions statement before you can proceed to log in.
Accepting the statement is a one-time action for each Avocet version.
When first launching AvocetVM.exe or ConfigTools.exe , you must accept the Terms and Conditions
statement that displays before you can log into the database.

1. Double-click AvocetVM.exe or ConfigTools.exe.


The Terms and Conditions statement is displayed in the foreground of the Login dialog.
2. Review the statement, and click Accept.
You are able to log into the database. You do not have to repeat this task for the current Avocet
version.

31
Microsoft ClickOnce
Avocet is a Microsoft Windows Presentation Foundation & Windows Forms application, which you can
publish using ClickOnce technology.
ClickOnce is a deployment technology that allows you to create a self-updating Avocet deployment
that can be installed and run with minimal user interaction.
You can publish a ClickOnce application in two different ways: from a web page or from a network file
share. A ClickOnce application can be installed on an end-user's computer and be run locally even
when the computer is offline, or it can be run in an online-only mode without permanently installing
anything on the end user's computer.
An Avocet ClickOnce deployment is self-updating. It can check for newer versions as they become
available and automatically replace any updated files. The deployment can specify the update behavior.
A network administrator can also control update strategies, for example, marking an update as
mandatory. Updates can also be rolled back to a previous version by the end user or by an administrator.
An Avocet ClickOnce deployment is inherently isolated; therefore, installing or running an Avocet
ClickOnce deployment cannot break existing applications. Avocet is completely self-contained; each
application is installed to and run from a secure per-user, per-application cache.
The ClickOnce deployment package consists of files that support the deployment of a current Avocet
implementation from a shared folder on a server system to multiple client workstations.

1 Using the Avocet Installer utility, install the ClickOnce deployment package, including the AvocetVM content, in a test
folder on a server system.

2 To publish the ClickOnce content from a production environment, create a shared folder either through a network file
share or through an IIS web server with an application folder. Client workstations can access the Avocet content from
the shared folder.

3 Copy the contents of the ClickOnce deployment folder from the test folder to the shared folder in the production
environment.

4 Maintain product and configuration updates in the ClickOnce deployment. Launch the Installer to update the ClickOnce
content in the test folder, and copy the updated content to the shared folder in the production environment.

Install ClickOnce (new install)


This task tells how to install the ClickOnce package on a system where the ClickOnce package has
not been deployed previously.
All systems where ClickOnce is extracted and deployed must have the .NET 4.5.2 runtime already
installed on them.
As a precaution, copy any custom Avocet configuration files and save them to a temporary location.
Before launching the Avocet Installer, make the requisite changes to the <GenerateBootstrapper>
stanza of the COgenV4_x64.xml or COgenV4_x86.xml file under the Installer\BuildProjects file path
of your Avocet Installer directory. Refer to Edit the COgenV4_xNN project file.
If you have removed the Oracle Instant Client, be sure that have deleted certain executables and
assembly files (dlls) before building your ClickOnce deployment. See the Help topic "Removing the
Oracle Instant Client" in the Installation Reference section.

1. Copy the AvocetVM folder of the Avocet installation package and paste it to the Avocet subfolder
of your Installer directory, as indicated in the following screenshot:

32 Avocet Production Data Management System Installation Guide


2. Copy your custom Avocet configuration files to their corresponding AvocetVM subfolders under
Installer > Avocet > AvocetVM.
3. Double-click InstallerUI.bat to launch the Avocet Installer utility.
4. Under Standard options, de-select all options except for ClickOnce for AvocetClient.
The ClickOnce installation includes the AvocetVM folder and its contents.
5. Under Deployment location, click Browse to locate and select your deployment folder.
6. Select the check boxes to accept the terms and conditions and the safety acknowledgment.
7. Click Install.
Windows Powershell is displayed. You are prompted to install any prerequisites. If the deployment
is successful, you receive a message saying that the Avocet ClickOnce deployment (x64) and (x86)
setup is finished and specifying the location of the log file. You are returned to the directory path
of the Installer folder.
8. Exit Windows Powershell by typing Exit at the directory prompt.
A ClickOnce container folder is created under the specified deployment folder. It contains two
subfolders: Publish_x64 and Publish_x86. The Publish subfolders contain the content that is
made available to Avocet client systems. The contents of each folder are the same, but designed
for 64-bit and 32-bit client systems respectively.

Edit the COgenV4_xNN project file


The COgenV4_x64.proj or COgenV4_x86.proj file builds and deploys the ClickOnce deployment
package. You should modify it to prevent certain errors from occurring when client workstations try to
download the package.

33
You will need to have the URL by which the client workstation connects with the ClickOnce deployment
server.

Note: If you are updating the project file after the initial ClickOnce installation, go to step 8.

1. Go to the Installer folder of your Avocet Installer installation path.


2. Access the BuildProjects subfolder (Installer > BuildProjects).
3. Open the appropriate project file (COgenV4_x64.proj or COgenV4_x86.proj) in a text editor, such
as Notepad++.
4. Locate the two <GenerateBootstrapper> stanzas just below the <!--Generate the setup bootstrapper
--> comment.
5. In each stanza, change the ComponentsLocation tag to "Absolute": ComponentsLocation="Absolute".
6. Below the ComponentsLocation tag, add the ComponentsUrl tag to each stanza, and set it equal
to the address by which client workstation connects with ClickOnce deployment server.
For example, you could enter "http://localhost/ClickOnce" :
ComponentsLocation="Absolute"
ComponentsUrl="http://localhost/ClickOnce"

Note: Specify the http protocol for the ComponentsUrl tag. Do not enter https here. At the
file share site or IIS web server, you can add the https binding.

7. Save the updated project file.


8. If you update the project file--for example, change the URL--after the initial ClickOnce installation
and deployment, then do the following:
a) Save the project file.
b) Delete the Publish_xNN subfolders from the ClickOnce installation directory.
c) Using the Avocet Installer, reinstall the ClickOnce for Avocet client package.
d) Update your file share or web server settings as needed, and restart the corresponding process
to initialize the changes.

ClickOnce publication site


To enable clients to access the published files, you first create a location in the production environment
where they can be shared.
You can create a
• network share
• web server with an application folder
Network share
If your network security allows you to do so in your work environment, you can set up a network file
sharing site to deploy the ClickOnce files to clients.
You can create a network shared folder using the Create a Shared Folder Wizard or the command
line. When creating your shared folder, make sure that you include the Publish_x nn subfolder in the
share.
Create a network share using the Wizard
This task shows how to create a network file sharing site using the Shared Folder Wizard.

1. On your Windows system, access the Start > Administrative Tools > Computer Management
> System Tools node, and double-click the Shared Folders entry.
2. Right-click the Shares folder to display the fly-out menu, and select New Share… .

34 Avocet Production Data Management System Installation Guide


The Create A Shared Folder Wizard is displayed.
3. Click Next, and follow the prompts.

Note: Administrator privilege is required to install prerequisites on client workstations.

4. Specify the permissions on the Shared Folder Permissions pane, and click Finish.
The shared folder is created.
5. Right click the newly created share, and choose Properties from the flyout menu.
The Properties tab is displayed.
6. Access the Share Permissions and Security tabs to verify or update permissions, and click OK
when done.
7. Verify your Windows Firewall settings to ensure that they enable the correct levels of access.
8. Copy the contents of the Publish_x nn folder to the specified network share.
Depending on network and security settings, your file share link will be similar to
\\serverName\DisplayName. Remote clients can access the Avocet content to deploy and update
it on their systems.

Create a network share (command line)


This task shows how to create a network file sharing site using the command line.

1. Create the folder to be shared on the appropriate drive. Note its physical path.
2. Go to Start > All Programs > Accessories, and right-click Command Prompt to display the fly-out
menu.
3. Click Run as Administrator to display the Command Prompt window.
4. At the prompt, enter
net share <sharename=drive:path>
where sharename is the network name of the shared folder and drive:path is the absolute physical
path of the shared folder: for example, ClickOnce=C:\AvocetDeployment\ClickOnce\Publish_xNN.

Note: You can type net share ? to display help for the net share syntax.

5. Copy the contents of the Publish_x nn folder to the specified network share.
Depending on network and security settings, your file share link will be similar to
\\serverName\DisplayName. Remote clients can access the Avocet content to deploy and update
it on their systems.

Web server application


This topic provides guidelines for setting up an Internet Information Services (IIS) web server application
for ClickOnce deployment.
You can refer to the IIS setup instructions in the Help topics Application servers and process groups
or Web Services API. You can choose to install the appropriate version of IIS (8.0 or 8.5) on Windows
2008 server or Windows 2012 server.
The referenced topics depict one approach for setting up a web server application. They are intended
as examples only. Your approach may differ depending on your network structure, security
considerations, firewall rules, and so forth.
When setting up your connection tree in IIS, you do not have to copy or extract folder contents. The
ClickOnce installation routine sets the directory structure.

35
Note: For the ClickOnce web server application, you will need to edit the IIS > Request Filtering
rules to ensure all filtering options are enabled.

Set up an IIS web server application for ClickOnce deployment


This task shows how to add an IIS web server application for ClickOnce deployment.
You have already defined your IIS web server.
See the Help topics Application servers and process groups or Web Services API for setup instructions.
Your IIS settings, especially your custom IIS settings, are saved to a web.config file that is created
in the physical path of the IIS web server application of your ClickOnce deployment, as shown in the
following screenshots:

Note: Do NOT delete or manually modify the web.config file outside the IIS environment.
Otherwise, you have to recreate your settings and customizations within IIS.

1. Launch IIS, and in the connection tree, right-click on the Sites > Default Web Site node of your
server to display the flyout menu.
2. Choose Add Application... .
The Add Application dialog is displayed.
3. In the Add Application dialog, complete the following fields:

36 Avocet Production Data Management System Installation Guide


Field Description

Alias Enter the display name of the deployment: for example, ClickOnce.

Application pool To select an application pool other than the default value, click the Select… button to choose
from the Application Pool drop-down list.

Physical path Specify the physical path to include the Publish_x nn subfolder: for example,
C:\rootDirectory\Publish_x nn.

Refer to the following example screenshot:

This connection uses pass-through authentication.


4. Click OK.
In the connection tree, your application node definition will look similar to the following example:

The content view of the ClickOnce application will look similar to the following:

37
5. Enable Windows authentication (IIS > Authentication) and directory browsing (IIS > Directory
Browsing).
6. Double-click IIS > Request Filtering to display the Request Fitlering pane.
7. Under the Actions column, choose Edit Feature Settings... .
The Edit Request Filtering Settings dialog is displayed.
8. Under the General heading, verify that all filtering options are selected, as in the following screenshot:

9. Click OK.

38 Avocet Production Data Management System Installation Guide


Configuration settings are saved to the web.config file residing in the physical path of your application
folder:
configuration>
<system.webServer>
<defaultDocument>
<files>
<add value="avocet.htm" />
</files>
</defaultDocument>
<security>
<requestFiltering allowDoubleEscaping=
"true" />
</security>
</system.webServer>
</configuration>

10. Continue next to set the default launch document, avocet.htm.

Set the default launch document


This task shows how to set the Avocet.htm file as the default launch document for ClickOnce clients.
You must set Avocet.htm file as the default launch document for ClickOnce.

1. Choose IIS > Default Document to display the Default Document panel, and choose Add… from
the Actions column to add avocet.htm as the default launch document.

2. Click OK, and ensure that Avocet.htm is first in the list.


3. Restart the web server (Actions > Manage Server > Restart) to initialize the changes.
4. Verify that the Avocet.htm launch page displays on the local system:
a) In the connection tree, select your ClickOnce application node.
b) Under the Actions, select Manage Application and choose your browse option (http or https),
depending on your security settings and bindings.
The Avocet.htm launch page is displayed, as in this example:

39
Set the security bindings
For your ClickOnce web server application, you can enable the HTTPS binding.
The ComponentsUrl tag in the COgenV4_x NN.proj project file must be specified with the http protocol.

1. In the IIS connection tree, select the Default Web Site node.
2. Under the Actions column, select Edit Site > Bindings... to open the Site Bindings dialog.
3. Choose Add... to open the Edit Site Binding dialog, and complete the following:
a) Choose https in the Type drop-down list.
b) Leave the IP address as All Unassigned.
c) Specify a port number. You can use the default 443 if it is not is use.
d) Choose the machine certificate as the SSL certificate selection.
e) Click OK to return to the Site Bindings dialog.
f) Click Close.
4. In the connection tree, choose your ClickOnce application folder, and then select IIS > SSL
Settings.
5. In the SSL Settings pane, make sure that the Require SSL check box is deselected.
6. Under the Actions column, choose Manage Application > Advanced Settings... to open the
Advanced Settings dialog.
7. Next to Enabled Protocols, enter http, and click OK.

Client workstations can access the ClickOnce deployment site using either http or https protocol. If
using https protocol, then in the URL string the client must specify the server name as listed in the
machine certificate.
Install the ClickOnce deployment on client workstations
In the production environment of a ClickOnce deployment, client workstations connect to an Avocet
production database through a network share or web server application folder.
The Avocet.htm launch document gives clients the option to install the Avocet runtime prerequisites.

40 Avocet Production Data Management System Installation Guide


Clients should install the runtime prerequisites that are supplied with the Avocet deployment package
in the network share or web server application folder. These prerequisites are customized for Avocet.
Clients should not install the runtime redistributable packages from Microsoft.
The customized Avocet prerequisites include, but are not limited to, the following:
• Microsoft Visual C++ Redistributable for Visual Studio 2015
• Microsoft .NET Framework 4.5.2
• Microsoft ReportViewer 2010 Redistributable
• Microsoft ReportViewer 2012 Redistributable
• Microsoft Visual C++ 2008 Runtime Libraries (x64)
• Microsoft Visual C++ 2008 Runtime Libraries (x86)
• Microsoft Visual C++ 2010 Runtime Libraries (x64)
• Microsoft Visual C++ 2010 Runtime Libraries (x86)
• Microsoft Visual C++ 2012 Runtime Libraries (x64)
• Microsoft Visual C++ 2012 Runtime Libraries (x86)
You must have administrative privileges on the client workstation to install the prerequisites.
Use Internet Explorer as your browser for accessing the Avocet ClickOnce deployment.
Have your login credentials ready to log into the network share or web server.
Determine whether you, as the client, access the Avocet ClickOnce deployment from a network share
folder or from an IIS web server application folder.
To install Avocet on end-user workstations:

1. Browse to the network share or web server application folder:


• If accessing a network share, then launch Remote Desktop Connection, enter the name of the
computer and your login credentials to connect to the share, and then double-click the Avocet.htm
file.
• If accessing the web server application folder, enter the URL in Internet Explorer (http:// or
https://serverHostName:portNumber/applicationName) and then enter your login credentials at
the prompt.
The Avocet launch page is displayed:

41
2. If this is a first-time installation on the workstation, select the 32-bit or 64-bit installation prerequisite
option, and follow the prompts.

Note: The Install Prerequisites (64-bit) option installs all components, including the 32-bit
runtime files.
During the installation of the runtime libraries, you may be asked to close certain Microsoft
applications. Otherwise a reboot is required. To avoid a reboot, close any open Microsoft
Word, Visual Basic, or Internet Explorer instances.

a) Execute the Run command to start the Avocet Setup for the selected option.
b) For each prerequisite, accept the license agreement, and click Install and follow any prompts.
3. Click the

button to start the Avocet implementation process.


4. Click Install to install Avocet on the client.
The application is installed in C:\Documents and Settings\<User_Name>\Local
Settings\Apps\2.0\<HexKey>\<HexKey>\AvocetVM.
You can also find the path of the installation in the About box of the application.
5. Once the installation is complete, the application is launched, and the Login dialog displays.
You can proceed to configure your Avocet implementation.
An Avocet icon is installed on the Desktop or an Avocet entry is added to the Start menu.

Launch the application on client workstations


The client can launch Avocet from either a desktop icon or the Start menu.

1. From the Start menu choose the Avocet entry, or from the Desktop choose the Avocet icon.
The application will launch and display the Login dialog.
2. Enter the login credentials and choose other options as required.

42 Avocet Production Data Management System Installation Guide


3. Click Login.
The application verifies the credentials and displays the interface.

Remove the application from client workstations


This task shows how to remove Avocet that has been installed on client workstations using the
ClickOnce deployment.

1. From the Start menu, select Control Panel > Add/Remove Programs.
2. Right-click Avocet from the list of installed programs, and choose Uninstall.
A prompt dialog is displayed.
3. Select Remove the application from this computer.
4. Click OK to continue uninstalling the program.

Update the ClickOnce deployment


If you make global configuration changes to your Avocet ClickOnce implementation or if you have
received new files from Schlumberger because of product updates, you will need to redeploy your
Avocet ClickOnce implementation. You can do so by relaunching the Avocet Installer utility.
As a safeguard, always back up your custom configuration files and save them to a temporary location.
When you recreate a published file set, save the existing Publish_xNN folder(s) to a temporary location
and let the Avocet Installer utility generate the new folders.
You update your published ClickOnce client files whenever you
• make changes to your Avocet configuration on the ClickOnce server
• receive new files from Schlumberger because of product updates
You perform these updates by rerunning the Avocet Installer utility and re-creating your ClickOnce
published output by repeating the ClickOnce for AvocetClient installation option. The ClickOnce
client then downloads the updated files.
To update your ClickOnce package on the ClickOnce server, follow these steps:

1. Move your current DeploymentFolder\ClickOnce\Publish_xNN folder and save it to a temporary


location.

By repeating the ClickOnce for AvocetClient installation option, you are creating an updated
Publish_xNN folder. Moving the existing Publish_xNN folder ensures that any outdated files are
removed.
2. Copy the updated content and any custom configuration files to their appropriate locations in the
Avocet folder under the Installer directory, as suggested by this screenshot:

3. Rerun the Avocet Installer utility by double-clicking InstallerUI.bat.


4. In the Avocet Installer wizard, select only ClickOnce for AvocetClient under the Standard options.

43
5. Under Deployment location, click Browse to locate the deployment folder where your ClickOnce
files reside.
6. Select the check boxes to accept the terms and conditions and the safety acknowledgment.
7. Click Install.
The Windows PowerShell window is launched, and updated Publish_xNN subfolders are created
in the deployment folder.
8. Compare the new Publish_xNN subfolders against the previous ones to note any changes.
9. Review the updated content and custom configuration files under the AvocetVM subfolder to ensure
that no errors exist.
10. After checking for errors, point the network file share or IIS web server application in the production
environment to the updated Avocet ClickOnce deployment package.
The latest updates are available to the ClickOnce clients for download.

Note: ClickOnce clients should also back up custom configuration files before downloading
the latest content.

ClickOnce troubleshooting guidelines


This topic provides troubleshooting suggestions for different issues you might encounter.
Issue Suggestion

Client unable to install Avocet from IIS web server application If the Application Install dialog does not launch, then check
folder your web browser's security settings.

Client unable to install Avocet from network share Browse to the sharedFolder \Publish_xnn\AvocetVM folder,
and click the AvocetVM.application manifest file.

The Application Install dialog is displayed.

Click Install.

Client unable to install prerequisites Verify that the COgenV4_xNN.proj file's ComponentsUrl
and ComponentsLocation attributes are updated.

Other troubleshooting considerations include the following:

44 Avocet Production Data Management System Installation Guide


• When copying the ClickOnce content between directories, be careful not to duplicate .dll files in the
Publish_xNN folder. Duplicate .dll files, even a single one, can create issues with Avocet.
• Do not modify the files in the Publish_xNN folder unless you are updating to a newer release or
adding custom files.

Install the AppServer


You install the application server on a Windows server 2012 R2 system.
You should have already installed Avocet. Before installing the application server, it is recommended
that you define in Avocet an LDAP user with pass-through authentication. The Avocet web services
interface that supports the application server requires pass-through authentication.
Refer to the Help topic Application servers and process groups for configuration details.
The application server requires a secure (https) Avocet web services interface, which the Avocet
Installer deploys along with a supporting Internet Information Services (IIS) 8.0 or 8.5 server that
connects with the application server via the web services interface. Upon completion of the install
routine, you are prompted whether you want to assign the domain computer certificate to the IIS https
binding. If you have custom or third-party certificates, you must configure the https binding manually
in the IIS console.

1. To install the application server to the target directory specified under Deployment location, do the
following:
a) Select AppServer
b) Verify the deployment location.
c) Select the Terms & Conditions and safety acknowledgement check boxes.
d) Click Install.
A prompt is displayed, asking for the port and path to the Schlumberger License server.
2. Specify the port number, host, and file path to the Schlumberger License server.
The default port number is 27000.
Windows Powershell is displayed. You are prompted to install any prerequisites.
3. At the Avocet AppServer Setup prompt, click Yes to attach your domain computer certificate to the
IIS https binding.
If you have third-party or custom certificates, click No. You must manually configure the IIS https
binding with the certificate.
4. Exit Windows Powershell by typing Exit at the directory prompt.

If you have not already done so, define an LDAP user with pass-through authentication.
You must edit the DeploymentFolder\AppServer\Web.config file.
Refer to the Application servers and process groups Help topic for configuration information.

Install Petrel Studio Plug-in 2015


The Petrel Studio Plug-in 2015 is compatible with Studio 2015.4 or Studio 2015.5.
Refer to the Help topic Avocet Integration: Studio for prerequisites.

1. To deploy the Petrel Studio Plug-in 2015 to the target directory specified under Deployment location,
do the following:
a) Under Extended options, select Petrel Studio Plug-in 2015.
b) Verify the deployment location.
c) Select the Terms & Conditions and safety acknowledgement check boxes.

45
d) Click Install.
Windows Powershell is displayed. You are prompted to install any prerequisites. If the deployment
is successful, you receive a message saying that the setup is finished and specifying the location
of the log file. You are returned to the directory path of the Installer folder.
2. Refer to the Help topic Avocet Integration: Studio to complete the installation and configuration.

Install OFM Plug-in 2014.1, 2016.1, or 2016.2


The OFM Plug-in 2014.1, 2016.1, or 2016.2 enables the export of the flow rate forecast of a completion
that is defined in an OilField Manager (OFM) project to an Avocet database. The OFM Plug-in 2014.1
has been tested against OFM versions 2014.1 and 2014.1.3.The OFM Plug-in 2016.1 has been tested
against OFM version 2016.1. The OFM Plug-in 2016.2 has been tested against OFM version 2016.2.
OFM Plug-in 2014.1, 2016.1, and 2016.2 require Avocet 2017.2 and the corresponding OFM version
(2014.1, 2016.1, and/or 2016.2).
The Avocet and OFM instances do not have to be installed on the same system. If they exist on
separate systems, then you can first deploy the OFM Plug-in to the system where Avocet is installed
and generate the installer package.You can then copy the installer package to the system where OFM
resides and launch the installation routine.

Note: You can install both OFM Plug-in 2014.1, 2016.1, or 2016.2 on the same system running
Avocet 2017.2.Your configuration must also have the compatible OFM versions (2014.n, 2016.1,
2016.2) installed on the same or different systems. As a best practice, both OFM integrations
should connect with the identical Avocet database.

Refer to the Help topic Avocet Integration: Oilfield Manager Projects for a complete list of prerequisites.

1. To deploy the OFM Plug-in 2014.1, OFM Plug-in 2016.1, or OFM Plug-in 2016.2 to the target
directory specified under Deployment location, do the following:
a) Under Extended options, select OFM Plug-in 2014.1, OFM Plug-in 2016.1, and/or OFM Plug-in
2016.2.
b) Verify the deployment location.
c) Select the Terms & Conditions and safety acknowledgement check boxes.
d) Click Install.
Windows Powershell is displayed. You are prompted to install any prerequisites. If the deployment
is successful, you receive a message saying that the setup is finished and specifying the location
of the log file. You are returned to the directory path of the Installer folder.
2. Refer to the Help topic Avocet Integration: Oilfield Manager Projects to complete the installation
and configuration.

Troubleshooting installation issues


This section provides guidelines for troubleshooting general installation issues.

Installation script does not run


This task shows how to resolve an issue that might occur when the PowerShell script is not signed.

1. Launch the Windows PowerShell in administrator mode.


2. Change directory (cd) to the directory path of the Installer folder.
If any folder names in the path contain spaces, enclose the entire file path in quotation marks.
3. Enter Get-ExecutionPolicy at the directory prompt:

46 Avocet Production Data Management System Installation Guide


If the message RemoteSigned is not returned, then you need to change the execution policy.
4. To change the execution policy, in the Windows Powershell enter the Set-ExecutionPolicy
RemoteSigned command at the directory prompt:
PS C:\AvocetInstaller2016\Installer>
Set-ExecutionPolicy RemoteSigned

Execution Policy Change


The execution policy helps protect you from scripts that you do not trust.
Changing the execution policy might expose you to the security risks
described in the about_Execution_Policies help topic at
http://go.microsoft.com/fwlink/?LinkID=135170.
Do you want to change the execution policy?
[Y] Yes [N] No [S] Suspend [?] Help (default is "Y"): y
PS C:\AvocetInstaller2016\Installer>
A message displays that explains the consequences of the execution policy change.
5. Type Y at the prompt to accept the policy change.
You are returned to the directory prompt.

Resolve set-up failed error


This task explains how to resolve the 'set-up failed' error that may occur while installing Avocet.
Check whether security patch 2966827 or 2966828 is installed on your system. If yes, follow the steps
given below:

1. Uninstall any patches from your system.


2. Go to Control Panel, and then click Turn Windows features on or off.
The Windows Featuresdialog box is displayed.
3. Select Microsoft .NET 3.5.1 from the list, then click OK.

47
If there are no patches installed on your system, follow the steps as mentioned below:
4. On your system taskbar, click Search Windows.
5. Type gpedit.msc in the box and press Enter.
The Group Policy Editorwindow is displayed.
6. Go to Computer Configuration then Administrative Templates and then click System.
7. On the right-hand side pane, double-click Specify settings for optional component installation
and component repair. By default, it is set to Not Configured.
8. Select Enabled, click Apply, and then click OK.

Post-installation considerations
After you install your Avocet components and define your project layer files, you can specify the
production day for collecting and aggregating data and a timeout interval for the Avocet client.
You define these parameters in the AppConfig_ProjectLayer .xml file of your implementation.

48 Avocet Production Data Management System Installation Guide


Production day start
At the initial implementation or deployment of a project, you (as administrator) can specify a start and
an end time for an actual production day in which to collect and aggregate data.
By default, daily allocation calculations begin at an inclusive start time of 12:00 PM (00:00:00) and
conclude at an exclusive end time of 12:00 PM (00:00:00).

Note: Because the end time is exclusive, the actual end time is 11:59:59 PM (23:59:59).

The calculations return the values for the specific day, not for individual hours. Monthly allocation
calculations use similar inclusive start times and exclusive end times. They start at 12:00 PM (00:00:00)
of the first day of the month and end at 12:00 PM (00:00:00) of the last day of the month. The
calculations return the values for the specific month.
The production day itself extends for 24 hours. When you specify a start time for the production day,
the system assumes the end time of the production day is 24 hours later. For example, if the production
day's inclusive start time is 6:00 AM (06:00:00), then the production day's exclusive end time is 6:00
AM (06:00:00) of the following day.

Note: The actual start and end times in this example are 6:00 AM (06:00:00) and 5:59 AM
(05:59:59).

In allocation processing, the default daily calculations are distinguished from the production day
calculations. The production day calculation values are aggregated for the specified production day
period, which excludes part of the current day and extends to the following day.

In the example outlined above, the production day calculations ignore values collected before 06:00:00
of the current day, as they belong to the previous production day.
You enable a production day data collection period by specifying the start time in the AppConfig_
ProjectLayer .xml.

Specify production day start


As an administrator, you can define a production day by adding a <prodDayStart> tag to your
AppConfig_ ProjectLayer .xml file.
You should specify the production day at the beginning of your project implementation. As a rule of
thumb, do not define or change the production day after you have implemented your project.

49
1. In your AppConfig_ ProjectLayer .xml file, locate the section containing the application ID of the
database to which you are connecting.
2. At an appropriate level in the XML hierarchy, add the <prodDayStart> tag, and specify a numerical
value between 00:00:00 and 23:59:59.
<prodDayStart>06:00:00</prodDayStart>
<firstDayOfWeek>Monday</firstDayOfWeek>
<fileLoaderConfig>LoaderConfig.xml</fileLoaderConfig>
<downtimeLevels>3</downtimeLevels>
<orgUnitLevels>4</orgUnitLevels>
The system automatically defaults to an exclusive end time that is set 24 hours after the
<prodDayStart> time.
3. Save theAppConfig_ ProjectLayer .xml file.
4. Start or restart the Avocet application to initialize the change.
The allocation process uses the production day start value to calculate and aggregate data for the
defined production day.

Specify a timeout interval for the Avocet client


You can specify a timeout interval that determines when your Avocet desktop or web client will shut
down after a period of inactivity. Actions such as mouse clicks and behind-the-scenes Avocet processes
are considered activity.
By specifying timeout intervals so that Avocet clients shut down after a period of inactivity, you can
free up licenses from inactive users. Thus you make them available to other users.

1. Open your project's AppConfig_projectLayer.xml file.


2. Locate the stanza where your application ID is defined.
3. Enter the following node <inactivityLogout>.
4. Just below the <inactivityLogout>, enter the following elements:
• <timeoutInMinutes> </timeoutInMinutes>
• <warningInMinutes> </warningInMinutes>
Your code block should display as shown in the following example having sample values:
<inactivityLogout>
<timeoutInMinutes> 10 </timeoutInMinutes>
<warningInMinutes> 1 </warningInMinutes>
</inactivityLogout>
The element <timeoutInMinutes> denotes the timeout interval after which the client shuts down.
The element <warningInMinutes> indicates the time that you are alerted before the shutdown. In
the above example, the system will shut down after 10 minutes of inactivity. You receive a warning
prompt one minute before the shutdown occurs.
When Avocet shuts down, the accompanying license is released and becomes available to another
user.
5. Save your project's AppConfig_projectLayer.xml file.
6. Restart the Avocet client.
A modal window displays a warning message at the designated interval before the shutdown occurs.
When the timeout interval is reached, you are prompted to log in again or to exit the application.

50 Avocet Production Data Management System Installation Guide


Define links to custom screen-level help files
You can link your custom help files to Avocet screens. This task shows how to define the links to the
custom screen-level help files and override the existing help link.

Note: See the Release Notes for instructions on linking to the standard Avocet Help that is
packaged with the installation.

You can link your custom help files to Avocet screens through the Home > Navigation > Add Context
Help Link ribbon toolbar option. Your custom help file overrides the existing help link. You can store
the help files locally, or you can link to external sites, such as Sharepoint. You can modify the
AppConfig_xxx.xml of an existing database to enable the context help feature. You invoke the help
content from the Help icon on the screen.
You should be familiar with the structure of the vmConfig.xml file before linking the help to a screen
type. Place your help file or help files in the desired location.
To define links to custom screen-level help files, follow these steps:

1. To be able to see the Add Context Help Link option, select the Diagnostic node in the Login
dialog when logging into the Avocet client.
2. On the screen or screen type that you wish to link the help file, click Home > Navigation > Add
Context Help Link to open the Custom Dialog Window.

3. Click the Type drop-down list to display the selection of screen types to which you can assign the
screen-level help. You can assign the help to a specific screen or to a group of related screens.

Screen Type Description

Node Assigns the help file to a specific tree node. Note that a custom deployment with different tree
node IDs would break any assigned help links.

Screen Assigns the help file to designated <screen> node for the currently displayed screen. This help
might be available to multiple screens defined under the <screen> node.

Screen_Config Assigns the help file to a <screenConfig> node that references the <screen> node of the currently
displayed screen.This assignment is more specific than the <screen> node assignment.Typically
you would use this assignment for a specific Item Editor screen type because Item Editor screens
reference the same <screen> node

Class Assigns the help file to the class name to which the currently displayed screen belongs. If
assigned to the class, the screen-level help will work in all configurations as long as the class
is not reused for multiple screen types: for example, Item Editor, Data Entry, Transaction, and
so forth

Select your screen type assignment.

51
4. Accept the corresponding ID value in the ID field.
It is tied to the screen type selection.
5. In the Link field, specify the location of the help file.
It can a relative path on your local system—for example, ..\\AvocetVM\Help. It can be an internal
URL, such as to a company’s Sharepoint site. Or, if your security permits, it can be an external
link.
6. Click OK.
7. Restart the Avocet client to initialize the change.
8. To display the linked help file, click the Help icon in the upper right-hand corner of the screen.

Enable custom screen-level help on an existing database implementation


This task shows how to edit the AppConfig_ProjectLayer.xml file to enable custom screen-level help
on an existing database implementation.

1. Open your project layer AppConfig_ProjectLayer.xml file under ..\AvocetVM\Config, and locate the
application ID definition that contains the database to which you connect.
2. At the same level as the <database> node, enter the following XML markup, highlighted in yellow
in the following example: <contextHelp>contextHelp.xml</contextHelp>.
<application id="ProjectLayerAppID">
<description>ProjectLayerAppID</description>
<database>
<driver>SQLSERVER</driver>
<sqlsyntax>SQLSERVER</sqlsyntax>
<connectString>Network Library=DBMSSOCN;Data Source=localhost,
1433;Initial Catalog=DatabaseName;User ID=sa;Password=MyPassword;
Application Name=AVM</connectString>
</database>
<contextHelp>contextHelp.xml</contextHelp>

3. Save the file.


4. When initializing your database through the Avocet Configuration Tools utility (configTools.exe),
be sure to choose the Load Context Help selection in the Database Initializer screen (Database
Tools > Database Initializer).

52 Avocet Production Data Management System Installation Guide

You might also like