Sensia Private – Customer Use

Sensia Private – Customer Use

Contents

Introduction to Avocet Mobile.......................................................................................5

Deployment workflow.....................................................................................................6
System requirements.....................................................................................................7
Install the Avocet Mobile application............................................................................8
Configuration..................................................................................................................9
Avocet web services API configuration.........................................................................................................9
Avocet Mobile configuration file....................................................................................................................9
Set the concurrent data update mode........................................................................................................11
Define custom change intervals..................................................................................................................11
Disable data source colors and labels........................................................................................................11
Save mobile login credentials.....................................................................................................................12
Avocet Mobile user configuration in Avocet desktop...................................................................................12
Enable security settings for mobile users...................................................................................................12
Apply security settings to the mobile user's system role.............................................................................15
Enable limit validation rules for the Avocet Mobile client.............................................................................16
Distribute sign-in information to Avocet Mobile users.............................................18

iiii Avocet Mobile Deployment Guide

4 Avocet Mobile Deployment Guide
Introduction to Avocet Mobile
®
Avocet Mobile is a mobile application for iOS 9 or higher or Android 8.1 or 9 mobile devices that oilfield
operators can use to efficiently review and collect data from well sites and related facilities.
As field operators travel though their daily routes, they can use the Avocet mobile application to review and
collect the following data on their mobile device.
• Completion (Daily reading, Downtime, and Well test)
• Gas meter (Daily reading and Monthly reading)
• Liquid meter (Daily reading and Seal data)
• Tank (Daily Inventory, Tickets, and Seal data)
• Compressor (Daily reading)
Avocet Mobile empowers you to verify field measurements and capture data electronically in your mobile device
even when working in remote areas. The auto-synchronization and local data storage features ensure that your
field data collection is supported when your mobile device is online or offline.
Bi-directional communication between the Avocet database and Avocet mobile provides a fully integrated
solution where route, stop, and equipment configuration and field data are synchronized.
During synchronization, the Avocet Mobile exchanges information with the main server, pushing the latest data
entries as well as receiving updates on the mobile device. To ensure data integrity, updates from the main server
include both data changes as well as meta-data, security, or configuration changes.

5
Deployment workflow
Avocet Mobile functions as an optional component in your existing Avocet Production Data Management System
(PDMS).

Deployment Server and Client Pieces

Avocet Mobile deployment includes server and client pieces. For the server component, a typical Avocet
installation can be hosted either on-premise, or in the cloud with additional pieces required to support the WebAPI
interface and mobile applications. The client piece is an app available for download from the app store. The
mobile app requires a minimal configuration to point to the designated Avocet WebAPI server.

Deployment workflow tasks

The deployment workflow focuses on configuring your existing network and user accounts to support Avocet
Mobile functionality.

6 Avocet Mobile Deployment Guide

System requirements
Avocet Mobile uses both onsite and hosted deployments that support .NET 4.8 (including ASP.NET WebAPI
v2), and the standard installation requirements for Avocet Desktop.

Component Description

Mobile – 4G/LTE with a

speed of 10 Mbps or above

Server Avocet 2017.2 server requirements

You can find all server requirement information in the Avocet Production Data Management System Help
under Administration > Installation > Avocet Production Data Management System Installation Guide
> Avocet installation preliminaries and references > Supported operating systems, servers, and
databases for Avocet desktop.

®
License Avocet 2017.2 licensing requirements including FLEXlm version 11.16.5.0 and Schlumberger Licensing
Tool 2020.1.

You can find Avocet licensing information in the Avocet Production Data Management System Help under
Administration > Installation > Avocet Production Data Management System Installation Guide >
Avocet installation preliminaries and references > Avocet 2017.2 licensing.

®
Mobile device iPhone 6, 6s, 7 or 8 running iOS 9.0 or later

Android: Google Pixel 2, Samsung Galaxy S9

7
Install the Avocet Mobile application
Install Avocet Mobile on your iOS 9.0 or later or Android 8.1 or 9 mobile device from the app store. After you
install the application, you can use the Start screen to establish a connection to Avocet desktop for synchronizing
your data records with those in the database server.

8 Avocet Mobile Deployment Guide

Configuration
Introducing Avocet Mobile into your Avocet PDMS requires minimal configuration to your appconfig_layer.xml
file, WebAPI configuration, and Avocet user accounts.

Avocet web services API configuration

®
Avocet web services API must be configured for Windows authentication.
Avocet web services API must be configured with the following items. For detailed information regarding
configuration, see the topics in the following Avocet Production Data Management System Help directory:
Administration > Deployment.
• Install IIS per the deployment documentation in the Avocet Production Data Management System Help
• Ensure that the default application is configured with HTTPS bindings
• Point Avocet web services API to the installation folder and setup Windows Authentication only
• Modify the Web.config file with the following elements:
• Point to the location of the config folder:
<avocet.config appConfigPath="..\..config" />
• Specify the Windows authentication type:
<authentication authenticationType="Windows" sessionTimeout="00:10:00"
/>

• Configure the desired App IDs with pass-through authentication in the Avocet Appconfig.xml file
<authenticationType>passthru</authenticationType>

Avocet Mobile configuration file

The application configuration file for Avocet Mobile is AppConfig_<appid>.xml.
The following elements and tags identify a mobile application configuration file:
<UiConfigMobile>
<base>UIConfig_Mobile_Base.xml</base>
<extension>UIConfig_MobileDataEntry_Base.xml</extension>
<extension>UIConfig_MobileDataEntry_OG_STD.xml</extension>
<extension>UIConfig_MobileDataEntry_OG_STD_Shell.xml</extension>
<extension>UIConfig_MobileDataEntry_<ClientAPPID>.xml</extension>
</UiConfigMobile>
The AppConfig_<appid>.xml file is similar to the Avocet desktop application configuration file with
updates to the following elements:
• <concurrencyMode>
• <ChangeIntervalSetting>
• <allowSavePassword>

9
 Note: Although you can combine your mobile configuration file with your desktop configuration file,
you should keep the files separate for easier file management.

We recommended that you have a single application ID for Avocet Mobile deployment. However if you require
multiple application IDs for Avocet Mobile deployment, then each application ID should be associated with a
separate web service configuration and dedicated application pool.
The pictures below show a sample configuration using multiple application IDs and multiple application pools.

Configure multiple application pools equal to the number of application IDs you would like to configure.
Create a separate site and associate each website with a separate application pool created in the above step.

Although there are separate sites configured, they may point to the same Avocet Web Service folder. The
Appconfig_<appid>.xml will contain all the application IDs.

10 Avocet Mobile Deployment Guide

Set the concurrent data update mode
In the AppConfig_<appid>.xml file, set the element concurrencyMode value to None. This ensures that
data updates synced from the mobile application always override the latest value in the database.
Warning: When the concurrencyMode value is row, when you sync data updates from the mobile application,
if the database and mobile application have new records for the same item, the database record takes precedence,
and the mobile application update is rejected.

Define custom change intervals

In the AppConfig_<appid>.xml file, you can define attributes in the ChangeIntervalSettings
element to determine the range of transaction data for each stop that is loaded in the mobile app.
The default configuration is for a range of 7 days:
<ChangeIntervalSetting ChangeInterval="EVENT" StartInterval="DAY"
StartOffset="-7" EndInterval="DAY" EndOffset="0" />
<ChangeIntervalSetting ChangeInterval="FIXED" StartInterval="DAY"
StartOffset="-7" EndInterval="DAY" EndOffset="0" />
<ChangeIntervalSetting ChangeInterval="MONTH" StartInterval="MONTH"
StartOffset="-2" EndInterval="MONTH" EndOffset="0" />

Note:
• If you have existing application IDs from a previous version that do not contain the MONTH setting for
the Change Interval Setting, you must manually add it in the file.
• The default range represents the typical number of days needed to collect field data while working offline.
Increasing this range may affect the performance or storage of your mobile device.

Disable data source colors and labels

In Avocet desktop, you can customize the Avocet interface by assigning colors to data fields so that you can
easily identify the source of the data. However, you can turn this feature off for all users by making a change to
the AppConfig_<appid>.xml file.

11
 To disable data source colors and labels for mobile users:
1. Edit the AppConfig_<appid>.xml file.
2. Find the following section in the file:
<mobileFeatures>
<enableSourceTypeColorDisplay>true</enableSourceTypeColorDisplay>
</mobileFeatures>

Note:
If you have existing application IDs from a previous version that do not contain the
<enableSourceTypeColorDisplay> setting, you must manually add it in the file before you
can disable data source colors.

3. Change <enableSourceTypeColorDisplay>true</enableSourceTypeColorDisplay>
to false.
4. Save and close the file.
The data source colors and labels no longer appear in the Avocet Mobile interface.

Save mobile login credentials

In the AppConfig_<appid>.xml file, set the element allowSavePassword value to true. This setting adds
a Save password slider to your Avocet Mobile Sign in screen.
Using the slider, you are only required to enter your password the first time that you sign in. Subsequent sign
ins on your mobile device use the password saved with the entered username.

Note: When using the Save password option, ensure that your mobile device is secured according to
your corporate requirements.

Avocet Mobile user configuration in Avocet desktop

Avocet Mobile users must have a mobile user enabled system role. Mobile users can only review and update
data for the routes that are assigned to their system role.

Note:
For an acceptable Avocet Mobile performance, it is strongly recommended that the total number of items
linked to a single route not exceed 300 and the number of items/screens per stop not exceed 10.
It there are more items per route, we recommend that you split the route into multiple routes. If a stop has
more items/screens per stop, we recommend that you split the stop into multiple stops.

Enable security settings for mobile users

Define the security settings for mobile users and their routes by identifying the system role of the user, and then
specifying the user definition.
• The Avocet web services must be enabled to permit the connection to the mobile device.
• A mobile license must be available for each mobile user when you configure their user account. The license
allows the mobile user to sync mobile device updates with the Avocet database server.

12 Avocet Mobile Deployment Guide

• In the Avocet Production Data Management System Help, review the topics under Administration >
Configuration > Security.
When identifying the system role and then defining the mobile user, consider the following:
• Decide whether to define a unique system role for the mobile user or use an existing one.
• Be familiar with the equipment types and related transactions that are associated with the stops on the routes
assigned to the mobile user. When defining the mobile user, you restrict her to a specific route or routes.
The following steps depict a representative scenario. Your steps and options may differ.

1. In the Navigation Tree of the Avocet desktop, select Administration > Users and Roles > System Role.
2. In the System Role Item Edit dialog box, select Actions > New to open a new record.
3. Enter a name for the mobile user role.
You do not have to specify a directory role at the level of the system role. You can clear the Directory Role
check box.

4. Select Administration > Users and Roles > System User.

5. In the System Role Item Edit dialog box, select Tools > New, and enter the following properties:

Option Description

User or Windows ID Assign a user name or Windows ID to the mobile user.

Directory User Because the Avocet web service requires Windows pass-through
authentication, the mobile user requires Active Directory
authentication.

Password The Password field is disabled for Windows pass-through

authentication.

Active User Select this check box.

Mobile Data Capture User Select this check box to activate the mobile license for the user. If
a license is not available, the message Insufficient
mobile data capture licenses is displayed.

13
 Option Description

Distinguished Name Enter the complete distinguished name, with the components
separated by commas, to include every level of the hierarchy:
Distinguished Name (DN): Common Name (CN), Organizational
Unit (OU), Domain Object Class (DC). For example: cn=Jim
Bob,ou=tester,do=acme. Your hierarchy may differ. Check with
your system administrator.

Email address The email addressed is disabled for AD users.

System Role Select the system role to which the mobile user is assigned. In the
Security Editor of the Avocet Configuration Tools utility, you
apply the security settings to the specified system role.

6. In the Security Profile drop-down list, select By route.

This selection restricts the user's access to the designated route.
7. Click Add to display the Select Item window listing the available routes.

14 Avocet Mobile Deployment Guide

 Note: You can use the Select Item window to add new routes.

8. Select the routes to assign to the mobile user, and then click OK.
9. Select Tools > Save.
10. Under Administration > System Maintenance > System Administration, run the process Generate Access
Control items.

Next, launch the Avocet Configuration Tools utility to apply the security settings to the system role to which
the mobile user is assigned.

Apply security settings to the mobile user's system role

In the Security Editor of the Avocet Configuration Tools utility, you define which permissions that the mobile
user has to transaction types, item types, and their properties.
• For the security settings to take effect, the mobile user must be assigned to the specified system role.
• Be familiar with the equipment types and related transactions that are associated with the particular stops on
the route or routes assigned to the mobile user so that you know which permissions to apply.
• Know how to use the Security Editor. Review the procedures and descriptions in the Security topic.
When defining your security settings for mobile users, consider the following:
• By default, mobile users have full permissions without restrictions to all actions.
• Determine which permissions (create, read, update, delete) you want to grant to the mobile user for transactions
and equipment types on her route or routes. Your organization's business requirements and security constraints
may determine what actions a mobile user can take.
• Decide which transaction and/or equipment properties that the mobile user can read and/or update on her route
or routes.
• Mobile users must have Execute permission to all web APIs related to the mobile implementation.
• Tree node (treeNode) and toolbar item (toobarItem) security do not apply to mobile users.
The following steps depict a representative scenario. Your steps and options may differ.

1. Launch the Avocet Configuration Tools utility (ConfigTools.exe), and access Security and Auditing Tools
> Security Editor to display the Security Editor screen.
2. Select the security role to which the mobile user belongs.

Note: If you do not see the role, click Sync Roles to update the list of defined roles.

3. Select type, and grant or restrict permissions to the available types on the user's route or routes.
4. Select property, and grant or restrict read and update permissions to the equipment and transaction properties.
5. Select webAPIRoute, and ensure that Execute permission is granted on the following mobile web APIs:
• MobileAuthentication
• CacheVersion
• MobileCodeList
• MobileConfigCache
• MobileItemTypeDefCache
• MobileConstants
• MobileItemSubTypeDefCache
• MobileSecurityCache
• MobileUnits
• OfflineSaving

15
 • MobileResourceCache
• RoutesAndStops
• UIConfigCache

6. Grant or restrict permissions to the other web APIs as needed.

7. Choose Save to assign the permissions.
8. If you changed any of the security settings, run the following processes.
a) In the Avocet desktop (AvocetVM.exe), go to Administration > System Maintenance > System
Administration.
The System Process screen is displayed.
b) Select the Generate the Access Control Items process in the Maintenance panel.
c) In the Run on panel, choose either the local system or an application server if you have installed one.
d) Choose Actions > Run in the ribbon toolbar.
The access control privileges are updated.

Enable limit validation rules for the Avocet Mobile client

The Avocet Mobile client supports limit validations rules created through the validation wizard. These rules
apply to specified equipment item properties of a particular stop on a corresponding route.
You must have the administrative right to edit validations for the particular properties. You should have sufficient
field knowledge to know the effective value range of equipment item properties such as temperature, pressure,
choke size, volume, mass, and so forth. Before proceeding, review the equipment item or items on the particular
stops of the route that will be affected by the validation rule. Notify the field operator who is assigned to the
route of any impending change to the validation rules.
You enter the limit validation rules on the Avocet desktop. In most cases, you specify the validation rule on a
field data transaction screen, such as the screens under the Field Data > Well Reading, Field Data >
Measurement, and similar subnodes of the desktop Navigation Tree. You enter the validation rules using the
validation wizard. Custom scripting is not supported on the Avocet Mobile client. Limit validation rules are
synced with the Avocet Mobile client whenever the mobile device is online and the Refresh all button is tapped
from the mobile app. Validation rules cannot be entered or updated through the Avocet Mobile client.
For detailed information about data validation, in the Avocet Production Data Management System Help, see
the topics in the The Basics > Data validation directory.

1. From the Navigation Tree, select a data transaction screen.

You must have security permissions to access the data elements. Depending on your custom configuration,
certain items may not appear on the Navigation Tree, or their location may have changed.
2. In the item Navigator of the transaction screen, select the item to which to apply the validation rules.
3. On the Home tab, in the Actions group, click Edit Validations.
If you do not have permissions to access validation rules, you will not see this button.
The Edit Validations wizard is displayed, listing the item properties that can have validation rules assigned
to them.

Note: A right caret indicates a property with an assigned validation rule. You can view a property's
assigned validation rules by expanding the property. Properties that are not expandable do not have
assigned validation rules.

4. In the Edit Validations wizard, select a property to assign a new validation rule to, and then click New
Validation.

16 Avocet Mobile Deployment Guide

5. Select the Numerical Limit Validation type, and then click Next.
6. Under Additional validation details, specify a date and time range during which the rule applies, enter the
high and low value range, and then click Next.
7. Under The validation should apply to, select the area to which the validation rule will apply, and then click
Next.
• Screen: Validation rules, when selected for a transaction screen, are applied to all items (wells, facilities,
and equipment).

Note: The Screen validation requires the id listed in the screen tag in the vmConfig_appid.xml
file to match the id in the UIConfig_MobileDataEntry_<ClientAPPID>.xml file.

• Sub-Type: Validation rules, when selected for a sub-type, are applicable to a specific categorization of
properties associated with an item. For example, wells can be classified into production and injection
wells, with each sub-type having its own set of properties. Similarly, meters can be classified into water
and gas meters, with each sub-type having its own set of properties. When you assign a validation rule
to a sub-type, it validates the set of properties associated with the sub-type.
• Item: Validation rules, when selected for an item, are applied to the specific item that was selected in the
item navigator when the validation rule creation wizard was launched. This allows the rule to be applied
to a specific item (well, meter, equipment, or facility).

8. Under When the data does not follow a validation rule it should be a(n), click Warning or Error to
indicate what should happen when there is a failure to meet the validation rule criteria.
• Warning allows the rule to fail, but does not prevent you from saving data in the transaction form when
it is created or edited. You can acknowledge the error and then save the transaction. Warnings are color
coded in yellow.
• Error allows the rule to fail and prevents you from saving the transaction until the error is corrected.
Errors are color coded in red. On the desktop, you have the option to acknowledge the error and continue
to save the transaction. On the Avocet Mobile client, you cannot acknowledge an error and save the
record.

9. Click Finish to create the validation rule.

The Edit Validations wizard returns to the list of properties, highlighting the property you just assigned the
rule to. When the mobile user taps Refresh or when the device returns to an online state, a sync occurs and
the validation rule is applied to the corresponding property on the desktop.

Note:
Currently Avocet Mobile supports Numerical limit validation, Value comparison, and Value exists
validation rules ONLY.
Bounded moving average and previous row tolerance validations are not supported.

17
Distribute sign-in information to Avocet
Mobile users
After you configure your Avocet PDMS environment for use with Avocet Mobile, distribute the required logon
information to Avocet Mobile users. Users can log on to Avocet Mobile in offline or online mode. To log on in
offline mode, you must log on to the mobile app at least ONCE with Save Password toggled on.

Distribute the following information to Avocet Mobile users. Users enter this information in the Start screen
on their mobile device.
• Secure URL of the server connection
You can change the URL using the Change server URL feature on the login screen.
• Password
If you enabled the save password option, on the Start screen, users can slide to save their password for
future logons.
• Application ID that references the database
Users can switch between application IDs that they have access to.

18 Avocet Mobile Deployment Guide