PI Manual Logger User Guide

Version 2010
OSIsoft, LLC
777 Davis St., Suite 250
San Leandro, CA 94577 USA
Tel: (01) 510-297-5800
Fax: (01) 510-357-8136
Web: http://www.osisoft.com

OSIsoft Australia • Perth, Australia

OSIsoft Europe GmbH • Frankfurt, Germany
OSIsoft Asia Pte Ltd. • Singapore
OSIsoft Canada ULC • Montreal & Calgary, Canada
OSIsoft, LLC Representative Office • Shanghai, People’s Republic of China
OSIsoft Japan KK • Tokyo, Japan
OSIsoft Mexico S. De R.L. De C.V. • Mexico City, Mexico
OSIsoft do Brasil Sistemas Ltda. • Sao Paulo, Brazil

Copyright: © 1997-2010 OSIsoft, LLC. All rights reserved.

No part of this publication may be reproduced, stored in a retrieval system, or transmitted, in any form or by any means, mechanical,
photocopying, recording, or otherwise, without the prior written permission of OSIsoft, LLC.

OSIsoft, the OSIsoft logo and logotype, PI Analytics, PI ProcessBook, PI DataLink, ProcessPoint, Analysis Framework, IT Monitor, MCN
Health Monitor, PI System, PI ActiveView, PI ACE, PI AlarmView, PI BatchView, PI Data Services, PI Manual Logger, PI ProfileView, PI
WebParts, ProTRAQ, RLINK, RtAnalytics, RtBaseline, RtPortal, RtPM, RtReports and RtWebParts are all trademarks of OSIsoft, LLC.
All other trademarks or trade names used herein are the property of their respective owners.

U.S. GOVERNMENT RIGHTS

Use, duplication or disclosure by the U.S. Government is subject to restrictions set forth in the OSIsoft, LLC license agreement and as
provided in DFARS 227.7202, DFARS 252.227-7013, FAR 12.212, FAR 52.227, as applicable. OSIsoft, LLC.

Published: 15 June 2010

Table of Contents
Chapter 1 Introduction ..................................................................................................................7
About Manual Data Entry ...................................................................................................8
Other PI Manual Logger Features......................................................................................8
PI Manual Logger Terminology ........................................................................................10

Chapter 2 Installation ..................................................................................................................11

Installation Components...................................................................................................11
Installation Flow Chart......................................................................................................12
Before You Start...............................................................................................................13
Install PI Manual Logger PC Client ..................................................................................15
Install PI Manual Logger MobilePC..................................................................................16
Post-Installation Procedures ............................................................................................18
Uninstall PI Manual Logger ..............................................................................................32

Chapter 3 Get Started and Tutorial ............................................................................................37

Start the PC Client............................................................................................................37
Menu Shortcuts ................................................................................................................40
Configure Global Options .................................................................................................43
Specify User Preferences ................................................................................................45
Configure the PI Server Connections...............................................................................46
Tutorial .............................................................................................................................47

Chapter 4 Create and Configure Tours .....................................................................................55

Create a Tour ...................................................................................................................57
Configure a Tour ..............................................................................................................58
Configure Tags.................................................................................................................66
Comments ........................................................................................................................69
Define Data Collection Scheduling...................................................................................72
Insert Operator Instructions..............................................................................................78
Define Data Collection Conditional Specification (CMDE)...............................................81
Set Tag Formats...............................................................................................................81
Set Data Validation Limits ................................................................................................82
Define Trigger Actions......................................................................................................83
Group Tags Within a Tour................................................................................................87
Add Tags to a Group ........................................................................................................88
Import Tag Group Hierarchy ............................................................................................89
Reorder Tags and Tag Groups ........................................................................................91
Set Tour Digital States .....................................................................................................93
Display Trends .................................................................................................................96

PI Manual Logger User Guide iii

Table of Contents

View All Work Requests...................................................................................................98

Work Offline......................................................................................................................99

Chapter 5 View and Edit Tour Runs.........................................................................................101

Create a New Tour Run .................................................................................................103
Enter Values for Tags in a Tour Run..............................................................................104
Import Tour Run Data.....................................................................................................116
Review a Tour Run.........................................................................................................116
View the History of a Tour Run ......................................................................................117
View Changes Made to the Tour Run ............................................................................118
View Unapproved Tour Run Data ..................................................................................119
View and Edit the Message Log.....................................................................................120

Chapter 6 Use PI Manual Logger Mobile .................................................................................121

Installation Flow Chart....................................................................................................122
Before You Start.............................................................................................................123
Mobile Device Application Installation............................................................................126
Post-Installation Procedures ..........................................................................................133
Transfer Data from the PC to a Mobile Device ..............................................................139
Start PI Manual Logger Mobile.......................................................................................144
Main Menus....................................................................................................................146
Data Entry Methods........................................................................................................150
View Tours .....................................................................................................................151
Enter Data ......................................................................................................................153
View Tag History ............................................................................................................163
View Message Logs .......................................................................................................165
View the Audit Log .........................................................................................................167
Leave, Confirm, or Cancel a Signature ..........................................................................168
Comment on Tags, Tag Groups, and Tours ..................................................................169
View Trends on Mobile Devices.....................................................................................171
Transfer Data .................................................................................................................173

Chapter 7 Use PI Manual Logger MobilePC ............................................................................179

Chapter 8 Security and Auditing..............................................................................................181

Manage the User Database ...........................................................................................181
PI Server Security ..........................................................................................................186
Auditing ..........................................................................................................................188

Appendix A Message Logs.......................................................................................................189

PI Manual Logger Configuration Tool ............................................................................190

Appendix B Global Settings and Maintenance.......................................................................191

Update Tag Attributes in the PI Manual Logger Database ............................................191
Archive Values ...............................................................................................................193
Queued Data ..................................................................................................................194
PI Manual Logger Maintenance .....................................................................................194

iv
 Appendix C Tour Migration ......................................................................................................195
Back Up 1.4.x Tour Definitions.......................................................................................197
Migrate Tour Data ..........................................................................................................198
What Is Migrated ............................................................................................................200
What Is Not Migrated......................................................................................................200

Appendix D Custom Web Service Access ..............................................................................201

Configure IIS in Windows XP/2003 ................................................................................202
Configure IIS in Windows Vista/Windows 7 ...................................................................204
Configure IIS in Windows Server 2008 ..........................................................................207
Post-IIS Configuration Procedures.................................................................................209

Appendix E Install and Configure SQL Server 2008 / 2005 Express Edition.......................211
System Requirements ....................................................................................................211
Install SQL Server Express ............................................................................................212
Use SQL Server Management Studio Express..............................................................213
Remote Connection to SQL Server Express .................................................................214

Appendix F Conditional Manual Data Entry (CMDE)..............................................................215

Data Types .....................................................................................................................217
Supported Operators......................................................................................................218
Supported Functions ......................................................................................................219
Sample Usage................................................................................................................226
Limitations ......................................................................................................................227

Appendix G Manual Creation of PI Tags .................................................................................229

Appendix H Upgrading PI Manual Logger ..............................................................................231

All Users Must Run the Same Version...........................................................................231
Before You Upgrade.......................................................................................................231
Upgrade a Previous Release of PI Manual Logger 2.x..................................................231
Upgrade a Previous Release of PI Manual Logger 1.x..................................................232
Upgrading PI Manual Logger for Mobile Devices ..........................................................232

Appendix I Technical Support and Resources.......................................................................235

Index ............................................................................................................................................239

PI Manual Logger User Guide v

Chapter 1

Introduction
PI Manual Logger is a set of client applications for manually entering data to the PI Server.
Your facility may have a significant amount of data that cannot be collected automatically
from instrumentation and control systems. PI Manual Logger provides these alternative data
entry methods:
Enter data using PI Manual Logger data entry screens on a PC.
Enter data on a Microsoft Windows Mobile device, Windows XP/Vista Laptop or Tablet
PC. Users can review, edit, or approve the data on the PC before sending it to the PI
Server. Some reasons to use mobile devices to collect data are:
A plant or unit has older analog instruments and the cost of new cabling and
instrumentation is too high.
Users may need to collect extra readings in a unit or plant for short periods, such as a
month or two, and existing instrumentation does not allow them to collect the data.
Certain data (such as lab readings, cooling water temperatures, water tide levels, tank
gauges, and manual field valve positions) only need to be collected once a shift, once
a day, or once a week.
Import data from an XML file. Users can review, edit, and validate the data in PI Manual
Logger before sending it to the PI Server.

PI Manual Logger User Guide 7

Introduction

About Manual Data Entry

Use a PC as a Data Entry Station

You can set up a PC as a data entry station using PI Manual Logger's built-in data entry
screens. You can also use the data entry screens for review. Lab data and plant log sheet data
entries are typically handled in this way.
The data collections are grouped in tours. Each tour contains a set of tags and tag groups that
define a set of data that will be collected manually.

Use Mobile Devices with Optional Barcode Scanners

You can collect data using mobile devices with PI Manual Logger Mobile (page 121). With
the barcode feature, you can use scanning devices to identify tags and enter data.

Import Data from Other Sources

You can import tour run data from XML files to PI Manual Logger. You can then review,
edit, and validate them before sending them to the PI Server.

Other PI Manual Logger Features

Multiuser and Network Ready
PI Manual Logger is a multi-user application and its data can be shared over a network. For
example:
You can enter data in PI Manual Logger on your PC, and other users can review or
change the data from their PCs.
For the same lab sample, different users can enter data as the test results become
available at different times. After the data set is complete, the data can be optionally
reviewed by a supervisor, approved, and then sent to the PI Server for archiving.

Centralized Storage of Manually Entered Data

PI Manual Logger stores all manually entered data in a centralized server environment. This
includes the collected process data, comments, and any message logs.

8
 Other PI Manual Logger Features

Wired and Wireless Data Transfer

PI Manual Logger supports both wired and wireless data transfer between a mobile device
and the server. Wireless data transfer is possible through the PI Manual Logger Web
Services.
Data transfer can be initiated from either the PC or the mobile device. In order for data
transfer to be initiated from a mobile device, PI Manual Logger Web Services must be
configured.
PI Manual Logger Web Services (PIMLWebServices) let you manage tour runs through
ASP.NET 2.0 Web services interface. Any device that can connect to a network can
communicate with the Web Services and transfer data wirelessly between the PI Manual
Logger database and a mobile device.
Through the PI Manual Logger Web Services you can do the following:
Retrieve the system date and time.
Retrieve any global settings.
Retrieve the selected tour definitions.
Retrieve the user database.
Upload any logs.
Upload tour run data.
The PI Manual Logger Web Services is run manually from the handheld device. Data transfer
from the mobile device using the PI Manual Logger Web Services is initiated manually by
the user.

Update Future Data and Cached Values

PI Manual Logger includes a Windows Services program that automatically communicates at
the data level with the target PI Server on a scheduled basis.
The PI Manual Logger Windows Service does the following:
Periodically checks any queued future data in the PI Manual Logger database and sends
this data to the target PI Server when the queued time passes.
Periodically updates the cached tag values in the PI Manual Logger database from the PI
Server.
Periodically updates the cached tag attributes and digital states in the PI Manual Logger
database from the PI Server.

PI Manual Logger User Guide 9

Introduction

PI Manual Logger Terminology

Terms with which you need to be familiar are defined below.
Cached Data: PI is the primary storage area for tag values, attributes, and digital states. PI
Manual Logger caches any tag data referenced in tours. Cached data can be updated in PI
Manual Logger with the targeted PI Server either manually through the PI Manual Logger
client application or automatically scheduled through the PI Manual Logger Windows
Service.
Central SQL Server: Database located on a server for central storage of tours to download
to the MobilePC and of tour runs to upload from the MobilePC for sending to the PI Server.
Conditional Manual Data Entry (CMDE): Conditional Manual Data Entry (CMDE)
provides a set of functions to determine if a tag should be collected based on conditions.
These conditions can include current values of other tags, previous values of tags, the time a
tag was collected, as well as many other options.
MobilePC: PI Manual Logger PC installed on a mobile computer (laptop, tablet PC) with the
ability to run in a disconnected mode from your network including the PI Server.
Queued Data: By design, the PI Server rejects future data, thus, preventing PI Manual
Logger from sending future recorded data to the PI Server. Instead, the application will save
the data in a state of queued. Queued data can be sent to the PI Server.
Tag Group: Associate tags within a tour by placing them into a Tag Group. The tag group
can be a piece of physical equipment or a set of measurements for a process that are usually
measured together.
Tour: A list of PI tags grouped together in order to facilitate data collection.
Tour Run: A set of values, statuses, comments, and associated timestamps taken for tags in a
tour.

10
Chapter 2

Installation

Installation Components
The PI Manual Logger set-up kits are distributed as two self-extracting executables: one for
the PC client and one for mobile devices.
PI Manual Logger consists of these components:
PI Manual Logger (PIML) on a PC (the PC Client). Use the PC Client to configure tours
and enter data collected from field equipment. Review, edit, or approve the data on the
PC before sending it to the PI Server.
PIML Mobile on a handheld device. Use PIML Mobile to collect data from field
equipment with a mobile device. You can transfer this data to the PC Client wirelessly if
the device supports a wireless connection or by cradling the device. Use the barcode
feature to scan equipment to identify tags and enter data.
PIML Windows Service. Use the Windows Service for the automatic update of queued
data and cached data on a server, typically the SQL server.
PIML Web services. Use this feature to transfer tours and tour runs wirelessly through
ASP.NET 2.0 Web services interface.
After completing the installation that meets your needs, there are post-installation procedures
that you must complete, section Post-Installation Procedures (page 18).
To uninstall PI Manual Logger, see section Uninstalling the Manual Logger (page 32).

PI Manual Logger User Guide 11

Installation

Installation Flow Chart

This flow chart can help you with the installation of PI Manual Logger.

12
 Before You Start

Before You Start

Verify that your systems meet the requirements listed in this section before installing the PC
Client.

System Prerequisites
Installation of an OSIsoft product relies on the presence of operating system components such
as the Microsoft .NET Framework. OSIsoft product set-up kits check for needed prerequisite
software during installation. If not found, the installation will stop and the user will be
prompted to install prerequisites. OSIsoft Prerequisite set-up kits are available for these target
operating system environments:
Windows XP and later (32-bit)
Windows XP and later (64-bit)
To determine which MS Operating System prerequisites you need, see the OSIsoft Technical
Support Prerequisites Kits product pages at this web site: OSIsoft Technical Support
Prerequisites Kits
(http://techsupport.osisoft.com/Products/Prerequisite+Kits/Prerequisite+Kits+Overview.htm).

Note: There is no support for the Itanium CPU.

PC Client Prerequisites
Minimum Software Requirements:
One of the following 32-bit only Windows systems:
Windows XP
Windows Server 2003
Windows Vista
Windows 7
Windows Server 2008
PI SDK 1.3.6.364 or higher

Server Prerequisites
Minimum Software Requirements:
PI Server version 3.4.363.68 or higher.
Internet Information Services (IIS) 5.0 or higher with ASP.NET 2.0 for wireless data
transfer from a mobile device through Web service support.
See the Windows help and administrator's guide for details on installing and configuring
IIS.

Note: You can install the Web server on a separate server from where the PI Manual
Logger PC Client or the PI Server is located.

PI Manual Logger User Guide 13

Installation

SQL Server Prerequisites

For PI Manual Logger PC, one of the following Microsoft SQL Server versions must be
available on a server, or optionally installed on the client. If the MobilePC feature in PI
Manual Logger PC is being used, then SQL Express must be installed on the client PC in
addition to a SQL Server edition installed on a server.
SQL Server 2000 SP4, or later.
SQL Server 2005
Express, Standard, or Enterprise
SP2, or later
32-bit or 64-bit
SQL Server 2008
Express, Standard, or Enterprise
32-bit or 64-bit

Note: If you choose to use SQL Express, you need to install SQL Management Studio
on the client as well.

Refer to the PI Manual Logger Release Notes for the latest service pack requirements.

14
 Install PI Manual Logger PC Client

Install PI Manual Logger PC Client

Start the client installation kit to install PI Manual Logger client applications. You can install
all the features or just selected ones. The Common and Documentation features are always
installed with any feature.

About these features:

Install the AutoSync Utility feature on the PC client only if you intend to use PI Manual
Logger Mobile. When AutoSync is enabled, PI Manual Logger synchronizes data with
the mobile device anytime it is cradled. After installation, refer to section Configure
AutoSync (page 175) for more details.
You can install the PIML Web Services and PIML Windows Service on different
systems. To install just these components on a system, use the same setup kit as the PI
Manual Logger client installation and choose the Windows Service and Web Services
components. Note that PIML Windows Services needs to be installed and running only
once for the PIML SQL Server Database. If you install it on all PIML PC Client
computers, the PIML Windows Services will be creating many unnecessary transactions.
If you choose to install the Database Files feature, blank SQL template database files are
included in the installation. You must later copy and attach the blank database template to
your SQL Server and point PI Manual Logger clients to the attached database. For details
about configuring the database location for PI Manual Logger clients, see Configure SQL
Server (page 18).

Note: There are additional steps you must take after installing PI Manual Logger PC
Client. When the installation is finished, refer to section Post-Installation
Procedures (page 18) and follow the ones appropriate for your factory application.

PI Manual Logger User Guide 15

Installation

Note: If you plan to use the PI Manual Logger Mobile feature, installation is described in
chapter Use PI Manual Logger Mobile (page 121).

Install PI Manual Logger MobilePC

This section lists the steps for installing MobilePC: This procedure assumes that the Central
SQL Server database has already been installed and configured as described in section Install
PI Manual Logger PC Client (page 15). The database schemas for both the MobilePC and the
Central SQL Server database must be the same.
1. Install SQL Server Express and SQL Server Management Studio Express on the mobile
PC.
2. Install the PI Manual Logger PC client on the laptop. Use the same procedure described
in section Install PI Manual Logger PC Client (page 15).
3. Copy the PimlWindowsMobilePC SQL Server database template files
(PimlWindowsMobilePC.mdf and PimlWindowsMobilePC_Log.ldf) located
in the PIPC\PimlWindows\Data folder to another folder on the mobile PC, for
example a folder named C:\PimlData.
Note that this same template file can be used for SQL 2008 Express or SQL 2005
Express.
4. Open the SQL Server Management Studio Express and attach the database. Use the same
procedure described in section Attaching Template Files for SQL Server 2008 / 2005
(SQL Express) (page 19). Configure the users, using the same procedure described in
section Adding a User Account to PIMLWindows Database (page 23).
5. Run the PIML Configuration Tools and set up the MobilePC database connections as
described in section Configuring the SQL Server Name (page 25). Use the database that
you specified in step 3.

16
 Install PI Manual Logger MobilePC

MobilePC Setup and Configuration

Specify the Central PIML SQL Server. Follow these steps:
1. Run PI Manual Logger and select MobilePC>Central SQL Server Setup.
2. In the Central Database Connection Setup dialog box that appears, specify the Central
PIML SQL Server connection.
3. Click Test to verify the connection.
a. If the connection test is successful, click Apply to close the dialog box.
b. If the connection test is unsuccessful, resolve the connection issues before applying
changes.

Note: The database schema version of the Central PIML SQL Server Database
must match the MobilePC database schema version. To upgrade the Central
PIML SQL Server Database schema, connect directly to the Central PIML
SQL Server Database through the Tools > SQL Server Setup menu item
with db_owner privileges to upgrade the database schema. Then set the
MobilePC database connection back to the MobilePC database through the
Tools > SQL Server Setup menu item. Then, go back to step 1.

Download your existing PIML Users and Groups from your Central PIML SQL Server
database. Follow these steps:
1. Click MobilePC>MobilePC Data Transfer.

2. Click in the center Tool Strip and Select the Receive Options tab.
3. Verify the Update user tables in my MobilePC check box is selected.
4. Click OK to close the dialog box.

5. Click in the center Tool Strip.

PI Manual Logger User Guide 17

Installation

Post-Installation Procedures
After completing the installation that meets your needs, there are post-installation procedures
that you must complete. These procedures are described in this section.

Configuring Security for the PC Client and Windows Services

Both the PI Manual Logger Windows client and the PI Manual Logger Windows Services use
the PI SDK to communicate with PI Servers. All users require read access to the PI Server.
The users who send tour run data to the PI Server require full write access to the relevant
tags. Therefore, a PI Mapping or a PI Trust connection is required.
To configure a PI Trust, refer to the documentation for the PI Trust Editor SMT3 Plug-In.
The name for the online help file is PI Trusts.chm. This help file provides details for
configuring server trust connections and adding and removing PI Servers from a server list.
Section PI Server Security (page 186) of this user guide also addresses PI Trusts.
PI Mapping requires PI Server version 3.4.380 or later and PI SDK 1.3.6 or later. OSIsoft
recommends using Windows security through PI Mappings. Windows security provides the
strongest authentication and full Windows account traceability in the PI Server log and audit
trail records. To configure a PI Mapping, refer to the PI Server documentation for details.
You can obtain the manual Configuring PI Server Security at the OSIsoft Download Center.

Configure SQL Server

PI Manual Logger stores all configuration metadata and temporarily stores manually entered
data in a SQL Server database. If you select Database Files during installation, all template
database files are installed. These include template files for SQL Server 2008 / SQL Express,
SQL Server 2005 / SQL Express, and SQL Server 2000. Files ending with 2008 are for SQL
Server 2008. Files ending with 2000 are for SQL Server 2000. Files that do not end with 2000
postfix are templates for SQL Server 2005 and SQL Express. These files are located in the
PIPC\PimlWindows\Data folder. There are two files, one with an .LDF extension, one
with an .MDF extension.

Note: For information about upgrading your SQL Server database to SQL Server 2005,
access the Microsoft download web site and obtain this manual: SQL Server 2005
Upgrade Technical Reference Guide. To upgrade existing instances of SQL
Server 2000 and 2005 to SQL Server 2008 you may want to obtain the SQL
Server 2008 Upgrade Technical Reference Guide at the Microsoft download web
site.

18
 Post-Installation Procedures

Attaching Template Files for SQL Server 2008 / 2005 (SQL Express)
A blank database template, including a file with the extension .MDF and a file with the
extension .LDF, is included in the installation kit and must be attached to the SQL
2008/2005 or SQL Express database server. The database template files reside in the
PIPC\PimlWindows\Data folder where PimlWindows.mdf and
PimlWindows_log.ldf are template files for SQL Server 2005 and
PimlWindow2008.mdf and PimlWindows2008_log.ldf are for SQL Server 2008.
Before attaching the appropriate database template for your SQL Server version, you must
copy the Manual Logger template database files to a secure location, for example on the SQL
Server. In addition, make sure the SQL Server account has Windows read/write permission to
these database files; otherwise an error message may appear. For example, you can copy the
database files to \Program Files\Microsoft SQL Server\MSSQL.1\Data so
that the SQL Server has full permission to read and write files under this folder.
To attach the database, follow these steps:
1. For SQL Server 2008 / 2005, run SQL Server Management Studio.
For SQL Express run the SQL Server Management Studio Express. Note that you must
install Management Studio Express separately from SQL Express.
2. Right-click Databases, as shown in the following figure, and select Attach.

3. In the Attach Databases dialog box that appears, click Add under the Databases to
attach field.
4. Browse to the database template file. The default location is
PIPC\PimlWindows\Data folder. Be sure that the template files have been copied
from this default location to a different location as described in the introductory
paragraph preceding this procedure.

PI Manual Logger User Guide 19

Installation

5. Select the PimlWindows.mdf and click OK. Verify the Current File Path for both the
Data and Log File Types in the Database Details section of the Attach Databases dialog
box.
6. In the Attach Databases dialog box, click OK to attach the database. The database
appears in the SQL Server Management Studio tree as shown in the following figure.

7. Add the PI Manual Logger users. Make sure that the Default Schema for these users is set
to dbo. Note that the Default Schema field cannot be populated for a Windows group;
'dbo' will be assumed.
To verify SQL Server security permissions, follow these steps.
1. In the tree, expand Security.
2. Select Logins, right-click the logon account, and select Properties.
3. Select the User mapping page.
4. Map the user appropriately for your system. For additional help, refer to your SQL Server
documentation.
5. Close the SQL Server Management Studio/Express.

20
 Post-Installation Procedures

Attaching Template Files for SQL Server 2000

A blank database template, including a file with the extension .MDF and a file with the
extension .LDF, is included in the installation kit and must be attached to the SQL 2000
database server. The database template files reside in the PIPC\PimlWindows\Data
folder where PimlWindows2000.mdf and PimlWindows2000.ldf are template files
for SQL Server 2000. Before attaching the appropriate database template for your SQL
Server version, you must copy the Manual Logger template database files to a secure
location, for example on the SQL Server. In addition, make sure the SQL Server account has
Windows read/write permission to these database files; otherwise an error message may
appear. For example, you can copy the database files to \Program Files\Microsoft
SQL Server\MSSQL.1\Data so that the SQL Server has full permission to read and
write files under this folder.
To attach the database, follow these steps:
1. Run SQL Server Enterprise Manager.
2. Right-click Databases, as shown in the following figure, select All Tasks, then Attach
Database.

PI Manual Logger User Guide 21

Installation

3. In the Attach Database dialog box that appears, click to locate the database that you
want to attach.

4. Browse to the database template file. The default location is

PIPC\PimlWindows\Data folder. Be sure that the template files have been copied
from this default location to a different location as described in the introductory
paragraph preceding this procedure.
5. Select the PimlWindows2000.mdf file and click OK. Verify the Current File Path for
both the Data and Log File Types in the Database Details section of the Attach
Databases dialog box.
6. In the Attach Database dialog box, clock OK to attach the database.
The database you selected appears in the SQL Server Enterprise Manager tree, as shown
in the following figure.

22
 Post-Installation Procedures

7. Add the PI Manual Logger users.

To verify SQL Server security permissions, follow these steps.
1. In the tree, expand Security.
2. Select Logins, right-click the logon account, and select Properties.
3. Select the Database Access tab.
4. Map the user appropriately for your system. For additional help, refer to your SQL Server
documentation.
5. Close the SQL Server Enterprise Manager.

Adding a User Account to PIMLWindows Database

Use the following procedure to add a basic user login account to the PimlWindows database
with read / write privileges. You must take these steps after the PimlWindows Database file
has been attached.
For SQL Server 2008 / 2005:
1. Open SQL Server Management Studio and connect to the appropriate SQL Server that
contains an instance of the PimlWindows database.
2. Select the computer.
3. In the tree, expand Security.
4. Right-click Logins and select New Login.
5. On the General page follow these steps:
a. Select the appropriate authentication. Microsoft recommends that you choose
Windows Authentication.
b. For Windows authentication, enter the Windows user in the Login name box. Click
Search to find the exact network username. For SQL Server authentication, enter the
SQL Server login name and password.
c. In the Default Database box, select PimlWindows.
6. On the User Mapping page follow these steps:
a. In the Map column select PimlWindows. Verify that the User column for
PIMLWindows defaults to the same Windows user you entered on the General page.
b. In the Default Schema column for PIMLWindows, enter dbo.Note that the Default
Schema field cannot be populated for a Windows group; 'dbo' will be assumed.
c. In the Database role membership for PimlWindows pane at the bottom of the
window, select the db_datawriter and db_datareader check boxes for basic
read/write privileges. Verify that Public role membership is also selected.
7. Click OK to save your settings. Then close SQL Server Management Studio.

PI Manual Logger User Guide 23

Installation

For SQL Server 2000:

Use the following procedure to add a basic user login account to the PimlWindows database
with read / write privileges. You must take these steps after the PimlWindows Database file
has been attached.
1. Open SQL Server Enterprise Manager and connect to the appropriate computer within the
SQL Server Groups that contains an instance of the PimlWindows database.
2. Select the computer.
3. In the tree, expand Security.
4. Right-click Logins and select New Login.

5. On the General tab follow these steps:

a. Select the appropriate authentication. Microsoft recommends that you choose
Windows Authentication.
b. For Windows authentication, enter the Windows user in the Login name box. Click
Search to find the exact network username. For SQL Server authentication, enter the
SQL Server login name and password.
c. In the Default Database box, select PimlWindows.
6. On the Database Access tab follow these steps:
a. Select the Permit column for PimlWindows. Verify that the User column defaults to
the same user entered on the General tab.
b. In the Database roles for 'PimlWindows' table at the bottom of the window, select
db_datawriter and db_datareader for basic read/write privileges. Verify that
Public role membership is also selected.
7. Click OK to save your settings. Then close SQL Server Enterprise Manager.

24
 Post-Installation Procedures

Configuring the SQL Server Name

After the database file has been attached to the server, you need to enter the SQL Server
Name (Instance Name) before using PI Manual Logger PC clients. Follow the steps below.
1. Run the PIML Configuration Tools by clicking Start>Programs>PI System>PI
Manual Logger>PIML Configuration Tools.
2. In the PI Manual Logger Configuration Tools dialog box that appears, select the
Database tab as shown below.

3. Double-click Setup Connection. The Database Connection Setup dialog box appears,
as shown in the following figure.

4. In the SQL Server Name field, enter the computer name and SQL Server Name
(Instance Name), if necessary. In the figure, the computer name is Weathertop. Since this
example uses SQLExpress, the default Instance Name also appears: SQLExpress. In most
cases, the Instance Name can be omitted for SQL Server 2008 / 2005.

PI Manual Logger User Guide 25

Installation

5. Make sure the Database Name is the same database name that appears in Management
Studio. Note that the name is not case sensitive. In addition, verify that the SQL Server
name matches the name at the top of the Management Studio tree. Refer to the following
figure.

6. If Windows Authentication mode is configured for your SQL Server instance, then check
the Use my Windows credentials check box in PI Manual Logger’s Database
Connection Setup dialog box. Microsoft recommends using Windows Authentication
when possible. Otherwise, deselect this check box and provide the appropriate SQL
Server login information.
7. Click Test to verify the connection and click OK in the message box that appears.
8. Click Apply to close the PI Manual Configuration Tools dialog box.

26
 Post-Installation Procedures

Configuring the Windows Services

The PI Manual Logger Windows Services uses the PI SDK to communicate with PI Servers.
All users require read access to the PI Server. The users who send tour run data to the PI
Server require full write access to the relevant tags. Therefore, a PI Mapping or a PI Trust
connection is required. Note that PIML Windows Services needs to be installed and running
only once for the PIML SQL Server Database. If you install it on all PIML PC Client
computers, the PIML Windows Services will be creating many unnecessary transactions.
To configure a PI Trust, refer to the documentation for the PI Trust Editor SMT3 Plug-In.
The name for the online help file is PI Trusts.chm. This help file provides details for
configuring server trust connections and adding and removing PI Servers from a server list.
Section PI Server Security (page 186) of this user guide also addresses PI Trusts.
PI Mapping requires PI Server version 3.4.380 or later and PI SDK 1.3.6 or later. OSIsoft
recommends using Windows security through PI Mappings. Windows security provides the
strongest authentication and full Windows account traceability in the PI Server log and audit
trail records. To configure a PI Mapping, refer to the PI Server documentation for details.
You can obtain the manual Configuring PI Server Security at the OSIsoft Download Center.
Open the Windows Computer Management utility to configure PI Manual Logger
Windows Services. Locate the service as shown in the following figure.

PI Manual Logger User Guide 27

Installation

Right-click the PI Manual Logger Windows Services, select Properties to open the
properties dialog box. Then select the Log On tab, as shown below.

Specify the security context for the services to run. By default, the service runs under the
Local System account.

Note: If you are using a Local System account for the Windows Services, make sure
that you have read/write data access permissions to the SQL Server database.
For best results, use a more secure account, such as the Network Service
account, instead of the Local System account to run the Windows Services.

Click OK to save your changes and close the property sheet.

By default, the service is scheduled to synchronize tour data with the target PI Server every
six hours and is configurable to a minimum of one hour. To change the default time, edit the
PulsorTime setting value in the PimlServiceSettings.xml located in the
PIPC\PimlWindows folder. If you make any changes to the PulsorTime setting, restart the
PI Manual Logger Windows Service.

28
 Post-Installation Procedures

The PI Manual Logger Windows Services logs its progress information in the Windows
Event Log. Use the Windows Event Log viewer to check the status of the PI Manual Logger
Windows Services, as shown in the following figure.

If you are running the Windows Services on a system where Manual Logger PC is not
installed, you must configure the SQL Server database connection:
Run pimltools.exe and click the Database tab.
If you have multiple SQL Server databases, you must install PI Manual Logger Windows
Services on separate systems and configure the SQL Server connection on each system to a
different database. You cannot run multiple instances of PI Manual Logger Windows
Services on the same system.

PI Manual Logger User Guide 29

Installation

Configuring PI Manual Logger Web Services

Configure the Web service settings before using PI Manual Logger Web Services to transfer
data between clients and the Web server when using wireless transfer on a mobile device.
If PI Manual Logger Web Services is installed, configure the security so that users have write
and read data access to the PI Manual Logger database. Choose from these user account
options:
Default ASP.NET user (Computer\ASPNET)
Windows authenticated user
SQL Server authenticated user
To verify SQL Server security permissions, follow these steps.
1. For SQL Server 2008 / 2005 / SQL Express, run SQL Server Management
Studio/Express. For SQL Server 2000 run SQL Server Enterprise Manager.
2. In the tree, expand Security.
3. Select Logins, right-click the logon account, and select Properties.
4. For SQL Server 2008 / 2005 / Express select the User mapping page. For SQL Server
2000 select the Database Access tab.
5. Map the user appropriately for your system. For additional help, refer to your SQL Server
documentation.
To configure the SQL Server database connection follow the steps below.
1. Open the PI Manual Logger Configuration Tools by double-clicking PimlTools.exe
in the PIPC\PimlWebServices folder.

NOTE: This is not the same Configuration Tool that the PI Manual Logger PC uses,
which is launched from the Start menu.

The PI Manual Logger Configuration Tools dialog box appears.

2. Select the Database tab.
3. Double-click Setup Connection. The Database Connection Setup dialog box appears.
4. In the SQL Server Name field, enter the computer name and SQL Server Name
(Instance Name), if necessary. In most cases, the Instance Name can be omitted for SQL
Server 2008 / 2005.
5. Make sure the Database Name is PIMLWindows.
6. If Windows Authentication mode is configured for your SQL Server instance, then check
the Use my Windows credentials check box in PI Manual Logger’s Database
Connection Setup dialog box. Microsoft recommends using Windows Authentication
when possible. Otherwise, deselect this check box and provide the appropriate SQL
Server login information.

30
 Post-Installation Procedures

7. Click Test to verify the connection and click OK in the message box that appears.
8. Click Apply to close the PI Manual Configuration Tools dialog box.

Use the Internet Information Services (IIS) Manager to configure the PI Manual Logger Web
Services security settings. Refer to Appendix Custom Web Service Access for detailed
procedures for this configuration. Setup differs, depending on your operating system.
Configure IIS in Windows XP/2003 (page 202).
Configure IIS in Windows Vista/Windows 7 (page 204).
Configure IIS in Windows Server 2008 (page 207).

PI Manual Logger User Guide 31

Installation

Uninstall PI Manual Logger

Before uninstalling PI Manual Logger, you must detach the SQL database first. See sections
Detaching SQL Server 2008 / 2005 (page 32) or Detaching SQL Server 2000 (page 34) for
more information.
After you have detached the SQL database, you can uninstall PI Manual Logger. For
Windows Vista (or later) operating systems, click Control Panel > Programs and Features.
For earlier Windows operating systems, click Control Panel > Add or Remove Programs.

Note: When you uninstall PI Manual Logger, all XML files and database files (MDF and
LDF) are renamed as <CurrentName>.previous, thereby preserving your data.

Detaching SQL Server 2008 / 2005 (SQL Express)

Note: Detaching a database requires Windows access permission to the PI Manual

Logger database files (.MDF and .LDF). See the SQL Server help for more
details.

To detach a SQL Server 2008 / 2005 (Express) database follow these steps.
1. Run SQL Server Management Studio (Express).
2. In the Connect to Server dialog box that appears, specify the appropriate SQL Server
name and login information.
3. In the Object Explorer, expand the Databases item and select the PI Manual Logger
database.

32
 Uninstall PI Manual Logger

4. Right-click the PimlWindows database and select Tasks > Detach. The Detach
Database dialog box appears.

Note: The Detach Database menu item is only visible if you have server or
database administrator privileges.

5. The Status column displays the current database state (either Ready or Not Ready).

Note: If the status is Not Ready, the Message column displays a short message that
is a hyperlink to more detailed information. To obtain more information, click
the Message hyperlink.

6. Be sure to select the Drop Connections check box to allow SQL Server Management
Studio (Express) to drop the connections automatically or close the applications
manually. For more information, click Help in the toolbar to view the Microsoft Detach
Database General Help page.
7. Click OK when you are ready to detach the database. Detaching the database does not
delete your database files.

PI Manual Logger User Guide 33

Installation

Detaching SQL Server 2000

Note: Detaching a database requires Windows access permission to the PI Manual

Logger database files (.MDF and .LDF). See the SQL Server help for more details.

To detach a SQL Server 2000 database:

1. Run SQL Server Enterprise Manager.
2. In the tree, expand the SQL Server Group, and then expand the appropriate server.
3. Expand the Databases item and select the PI Manual Logger database.

34
 Uninstall PI Manual Logger

4. Right-click the PimlWindows database and select All Tasks > Detach Database. The
Detach Database dialog box opens.

Note: The Detach Database menu item is only visible if you are a member of the
sysadmin fixed server role.

5. The Database status group displays the current database state. Any open connections can
be closed at this point by clicking Clear or by closing the applications manually. The
database can only be detached after the STATUS displays: The database is ready to be
detached.
6. Click OK when you are ready to detach the database. Detaching the database does not
delete your database files.

PI Manual Logger User Guide 35

Chapter 3

Get Started and Tutorial

Start the PC Client

After the client has been configured, start PI Manual Logger. Select Start > All Programs >
PI System >PI Manual Logger > PI Manual Logger.The PIML Login dialog box appears.
If you have not previously configured your database connection, you are prompted to do so.
Refer to section Configuring the SQL Server Name (page 25), steps 4-7.
If this is your first time using PI Manual Logger, use the default user name, piml, and the
default password, piml. This account has full permissions to all PI Manual Logger features.

Note: The password to log in to the PI Manual Logger client is case-sensitive.

See User Database Management (page 181) for details on users and permissions
management.

PI Manual Logger User Guide 37

Get Started and Tutorial

PI Manual Logger Main Window

The Getting Started dialog box appears when you start PI Manual Logger. This dialog box
provides shortcuts to some common tasks, including: managing tours and tour runs, entering
data, transferring data between PC and a docked device, and managing PI Manual Logger
user accounts and user groups.
The status bar at the bottom of the main window shows the current PI Manual Logger user,
current SQL Server database, the current connected PI Server, any status messages, and the
current version of the main PI Manual Logger application. Click the information on the status
bar to change settings or show details.

Menu Bar
Use the File menu to manage the user database, view the message log, maintain cached PI
data, change your user password, switch users, manage work requests, and exit the
application.
Use the Tours menu to create and manage tours and tour runs, import tour runs and tour data,
and enter data.
Use the Mobile Devices menu to initialize data transfers between mobile devices and the host
(PC or server), configure the way mobile devices synchronize, initialize device databases, and
download the user database from the PI Server to a mobile device.
Use the Tools menu to set up user preferences and perform administrative tasks, such as
change the PI Server, change the SQL Server database, and set global options.

38
 Start the PC Client

Use the Offline menu to specify the SQL Server and test the connection. select offline
transfer options to a mobile device, and to conduct tour runs while not connected to the PI
server.
Use the Window menu to select a PIML window in which to work, if more than one window
is open.
Use the Help menu to access the PI Manual Logger help system and view system
information.

Note: To access these menus, the Getting Started dialog box must be closed.

PI Manual Logger User Guide 39

Get Started and Tutorial

Menu Shortcuts
The following table describes the options on the Shortcut Menu that appear when you click
items on the main Menu.

PIML Menu Shortcut Options

To Do This Operation... ...click PIML, ...or press

and select... ALT+P+
Display list of tasks that are frequently done. Getting Started Window. G
Create user groups and users. Manage User Database. U
Open the Message Log. Message Log. M
View PI tags, digital states, queued data, PI Tags and Digital T
cached data, archive values, and tours in States.
which a tag is used.
Change a password. Change My Password. P
Change user. Switch Logon User. S
Work with Work Requests, including viewing, Work Requests. W
exporting, and deleting them.
Close PI Manual Logger. Exit. X

Tours Menu Shortcut Options

To Do This Operation... ...click Tours, ...or press

and select ... ALT+T+
Create a tour. New Tour. N
View existing tours. Tour List (Data T
Definition).
Execute a tour run and enter data. Tour Run List (Manual R
Data Entry and Review).
Manage unapproved tour run data stored in Tour Run Maintenance. M
the database.
Import tour run data from a file. Import Tour Run (Import P
Manual Data).

40
 Menu Shortcuts

Mobile Devices Menu Shortcut Options

To Do This Operation... ...click Mobile Devices, ...or press

and select ... ALT+M+
Display list of tasks that are frequently done Common Tasks. C
with a mobile device.
Display device information, such as the Device Information. D
operating system, manufacturer, memory,
and so forth.
Open the Mobile Data Transfer Wizard Mobile Data Transfer W
window, which allows you to choose various Wizard.
options before transferring data to or from a
device.
Initiate a data transfer to or from a mobile Device Data Transfer. T
device.
Initialize (clear) the database on the mobile Initialize Device I
device. Database.
Open the Mobile Database Location Setup Mobile Database L
window to specify a file if the device is not Location Setup.
cradled.
Specify device information, such as location Mobile Device Settings. M
of the database file, device ID, single user
mode, and so forth.

Tools Menu Shortcut Options

To Do This Operation... ...click Tools, ...or press

and select ... ALT+O+
Specify system hosting the PI Server. PI Server Setup. P
Specify system hosting the SQL Server, the SQL Server Setup. S
database name, and test the connection.
Specify whether the Getting Started window User Options. U
opens at startup and set the trending time
range.
Specify options, such as the number of PI tag GLobal Options. G
values to cache per tag, enable message log
options, and the Admin User group.
Define comments that users can choose Comment Templates. C
during data entry.

PI Manual Logger User Guide 41

Get Started and Tutorial

MobilePC Menu Shortcut Options

To Do This Operation... ...click MobilePC, ...or press

and select... ALT+B+
Initiate a data transfer to or from a laptop. MobilePC Data Transfer. T
Specify Send options for the laptop, such as MobilePC Data Transfer O
whether to import all tour runs or only Options.
completed tour runs, and Receive options,
such as whether to reload the database on
the laptop, update the PI tag values, and so
forth.
Specify system hosting the SQL Server for Central SQL Server C
the laptop, the database name, and test the Setup.
connection.
Do work, such as collecting field data, while Work Disconnected. W
disconnected from the company network.

42
 Configure Global Options

Configure Global Options

If you are a member of the administrative PI Manual Logger user group, you can configure
the options that affect all PI Manual Logger user sessions. To do this, choose Tools > Global
Options.
On the General tab, specify the number of tag values that PI Manual Logger caches. If your
factory application may potentially have several operators writing data to the database it is
recommended that you select the Enable SQL Server Snapshot Isolation Level check box.
This facilitates any read operations that are made during the write operations. Otherwise
delays may occur due to the multiple write transactions.

On the Message Logging tab, specify the type of events that the system enters in the PI
Manual Logger logs.

PI Manual Logger User Guide 43

Get Started and Tutorial

On the Security Settings tab, specify or change the PI Manual Logger user group that has
administrative privileges in PI Manual Logger. You can also allow or disallow users to delete
PI data in PI Manual Logger.

Caution: If you are a member of the current Admin User group and you change the
administrative user group to a group you do not belong to, you can no longer
access the Global Options dialog box.

44
 Specify User Preferences

Specify User Preferences

To specify your application user level preferences choose Tools > User Options.
On the General tab, specify whether you want the Getting Started dialog box to show up
each time you start the application. Refer to the PI Manual Logger Main Window (page 38)
section for details about the Getting Started dialog box.

On the Trending Options tab, adjust your default trending time range for all trends inside the
application.

Note: You can adjust the trend time range for an individual trend with the pop-up menu
of that trend. See the View the History of a Tour Run (page 117) section for details
about how to adjust the display time range for an existing trend.

PI Manual Logger User Guide 45

Get Started and Tutorial

Configure the PI Server Connections

If you are a member of the administrative PI Manual Logger user group and you have
multiple PI Servers available for manual data entry, you can configure the PI Server
connections. To do this, choose Tools > PI Server Setup.

Click Advanced to open the PI Connection Manager dialog box. Use this dialog box to add
and remove PI Servers in your PI Server table.

There is a one-to-one correspondence between a PIML Windows database and a PI Server.

Therefore the PIML Windows database must connect to a single PI Server only.

CAUTION: The changes you make to the targeting PI Server affect all PI Manual
Logger Clients and PI Manual Logger user sessions. This has the potential risk of
causing other users who are currently logged in to lose their point data. OSIsoft
recommends that you use separate PI Manual Logger databases if you have
multiple PI Servers and multiple PI Manual Logger clients.

46
 Tutorial

Tutorial
The following are PI Manual Logger exercises. Some of the exercises cannot be completed
unless you have completed the previous ones.
Solutions are provided at the end of each exercise. All the material, including data files
needed to complete some of the exercises, can be found at Prerequisite Kits
(http://techsupport.osisoft.com/Products/Prerequisite+Kits/Prerequisite+Kits+Overview.htm). Select
Training Materials from the Download Center.
These exercises use the Microsoft Windows Mobile 5.0 Emulator and the Pocket PC image
with the PI Manual Logger Mobile installed on it. The PI Manual Logger client application
uses Microsoft SQL Server Express.

Preparation

These steps are necessary for the tutorials that follow.

1. Create a Data Entry Only group and call it Operators.
2. Add a user called DataCollector and assign it to the Operators group.
3. Have a PI System Administrator create 12 tags, six floating point and six strings using
these conventions:
PIML-Float1, PIML-Float2, PIML-Float3, and so forth.
PIML-String1, PIML-String2, PIML-String3, and so forth.
To create the DataEntryOnly group and the DataCollector user, follow these steps:
1. Start PI Manual Logger. Log in with the default user ID and password: piml.
2. Click PIML>Manage User Database. The PI Manual Logger User Management
window appears.

PI Manual Logger User Guide 47

Get Started and Tutorial

3. In the Permission Groups panel, click . The New Permission Group dialog box
appears.
4. Enter Operators in the Group Name field. An entry for the Description field is
optional.
5. Click OK to save the new group and close the dialog box.
6. In the Users panel, click . The New User dialog box appears.
7. Enter DataCollector in the User Name field. An entry for the Description field is
optional.

8. Enter a password and confirm it. Then click OK to save the user and close the dialog
box. The User Database Management dialog box appears as shown below.

At this point you need to add the DataCollector user to the Operators group.
1. In the Permission Groups panel, double-click the Operators group. The Group
Properties dialog box appears.
2. Click the User Membership tab. Then click Add.
3. Select the DataCollector user and click OK. The DataCollector user appears as a
member as shown in the following figure.

4. Click OK to close the Group Properties dialog box.

48
 Tutorial

Create a Tour

In this exercise you create a tour for collecting field data.

Objectives
Create a tour in the PI Manual Logger client for later data collection. This assumes that tags
are created on the PI Server, a valid PI Trust or PI Mapping exists, and users are configured
in PI Manual Logger in order to collect data and perform these exercises.

Problem Description
You must set up a tour so that one of your operators can collect data every hour. Establish a
tour for the DataCollector user to gather values.

Approach
You must collect values periodically for the following tags:
PIML-Float1, PIML-Float2, PIML-Float3, PIML-Float4, PIML-Float5, PIML-Float6
PIML-String1, PIML-String2, PIML-String3, PIML-String4, PIML-String5, PIML-
String6
These tags were created on your PI Server by your PI System Administrator. Refer to the
important note before this exercise for tag and user definitions.
Open the PI Manual Logger application and start a New Tour. Call the tour Hourly Tour.
The PIMLADMINS will have Full Permissions and the Operators will be the Data Entry Only
Group.
Add the tags listed above to the tour definition.

Step-by-Step Solution
Be sure you follow the procedures listed in Preparation (page 47) before starting.
1. Start PI Manual Logger.
2. Log in using the PI Manual Logger Administrator account (userid piml and password
piml by default).
3. Select Tours > New Tour (Or press ALT+F5.)
4. Click Next.
5. Enter the tour name Hourly Tour. The description is optional. Then click Next.
6. In the Full Permission Group select PIMLADMINS.
7. In the Data Entry Only Group select Operators. Then click Next.

PI Manual Logger User Guide 49

Get Started and Tutorial

8. Click Add.
9. In the Tag Mask field enter PIML- and click Search.
10. Click Select All and click OK.
11. Click Next.
12. Click Finish.

Run a Tour in PI Manual Logger Mobile

In this exercise you download a tour to a mobile device and execute a tour run from the
device.

Objectives
You want to download your tour from the PI Manual Logger application to your PI Manual
Logger Mobile database on your handheld device. Then you run the tour on the hand-held
device.

Problem Description
You have defined a tour and want to download it to your PI Manual Logger Mobile database
on a handheld device. This example assumes you have gone through the installation of the
software and the Mobile Data Transfer Wizard to set up the device and its database. You
want to collect data with the hand-held device.

Approach
Make sure PI Manual Logger is started on your PC. Make sure your handheld device is
running and cradled but not running PI Manual Logger Mobile. Open Microsoft ActiveSync
and connect.
Download the database from the PC application using Device Data Transfer feature on the
PC. Select Hourly Tour and move it from the pane on the left (PC Tour List) to the pane on
the right (Device Tour List). Click . If the transfer fails, repeat the process.
When the message "Done" appears click Close. Your tour is loaded to the hand-held device
and is ready for a new tour run.
On your hand-held device, open PI Manual Logger. Log in using the DataCollector user.
Click to start a new tour run. Use your current time as the run time. Enter data for each of
the tags (six are floating point numbers and six are string values).

50
 Tutorial

Step-by-Step Solution
The general procedure consists of these steps:
1. Download the tour.
2. Run the tour.
3. Upload the data to the PC.

Download the Tour

1. Make sure the handheld device is running and that PI Manual Logger Mobile is not
running.
2. Cradle the hand-held device.
3. Start Microsoft ActiveSync.
4. Select File > Connections. Click Connect.
5. Open PI Manual Logger on your PC.
6. Login using the PI Manual Logger Administrator account (userid piml and password
piml by default).
7. Select Mobile Devices > Device Data Transfer.
8. Select Hourly Tour and move it from the pane on the left (PC Tour List) to the pane on
the right (Device Tour List).
9. Click .
10. Wait for the message "Done" to appear in the log, then click Close.
11. Close PI Manual Logger.

Run the Tour

1. Open PI Manual Logger Mobile on the device.
2. Log in using the DataCollector user.
3. Click to start a new tour run.
4. Use your current time as the run time.
5. Click OK.
6. Enter in two digit values for the floating point tags and colors (red, blue, green or other
strings) for the string tags.
7. Save and close your tour.
8. Close PI Manual Logger Mobile on the device.

PI Manual Logger User Guide 51

Get Started and Tutorial

Upload the Data to the PC

1. Verify that the hand-held device is cradled and that Microsoft ActiveSync is running.
2. If a connection has not already been made automatically, in the ActiveSync window,
select File > Connections. Then click Connect.
3. Open PI Manual Logger on your PC.
4. Log in using the PI Manual Logger Administrator account (userid piml and password
piml by default).
5. Select Mobile Devices > Device Data Transfer. Verify that Hourly Tour is listed in the
Device Tour List panel.
6. Click .
7. Wait for the message "Done" to appear in the log.
8. Verify that the new tour is listed in the Device Tour Run List panel.

Approve the Data for the PI Server

In this exercise you approve field data before uploading it to a PI Server.

Objectives
Learn how to create an approval workflow for your collected data.

Problem Description
You have a group of operators who collect data with a handheld device, and you want to
review the data before sending it to the PI Server. You need to set up your tours so that a data
collection group has the ability to collect values but not write data to the PI Server. You use
the piml user to approve and archive the data.

Approach
On the PC you need to modify the Tour Options setting so that the Auto Send Data to PI
check box is cleared, and the Manual data must be submitted for approval check box is
selected. After you save that change, update the tour on the device by transferring the tour
again. Then execute a tour run on the handheld device and transfer the data to the PC. The
status should read Completed.
Open the Tour Run List window on the PC. Select the tour in the Tour List (upper) panel
and then double-click the specific run in the Tour Run List (lower) panel. Review the tour run
and the values collected. You can modify or remove any bad values. You can also add or edit
any comments. Click In the lower bar to archive the values.

52
 Tutorial

Step-by-Step Solution
1. Open PI Manual Logger on your PC.
2. Log in using the PI Manual Logger Administrator account (userid piml and password
piml by default).
3. In the Tour List pane, double-click the tour that contains that data you want to approve.
4. Click Tour Options.
5. In the General tab:
Select the Manual data must be submitted for approval check box.
Clear the Data Entry Only Group can send data to PI check box.
Clear the Auto Send Data to PI check box.
6. Click OK.
7. Transfer the updated tour to the device and execute a tour run as the DataCollector user.
8. Transfer the collected data back to the PC. See section Run a Tour in PI Manual Logger
Mobile (page 50).
9. Select Tour Run List on the PC and select the tour in the Tour List (upper) panel.
10. Double-click the tour run in the Tour Run List (lower panel) that you need to review. The
status will read Completed.
11. Click Yes to review the tour.
12. Select the Data Entry Sheet tab at the top and review the numbers. Make necessary
changes and/or add a comment.

13. When finished, click to archive the data in the PI Server.

You have created a tour, run the tour on a mobile device, and uploaded the data to the PI
Server. Now read the following chapters to learn about more advanced features of PI Manual
Logger.

PI Manual Logger User Guide 53

Chapter 4

Create and Configure Tours

In PI Manual Logger, a tour is a list of tags grouped together in order to facilitate data
collection.
To manage tours, choose Tours > Tour List (Data Definition).
The Select a Tour dialog box lists available tours from the PI Manual Logger database. In
the Tour List pane, you create, modify, and delete tours. In the Search Options pane, you
can search for tours in the Filter By box, and you can choose to display only your tours or all
tours in the List Options box.

To create/edit tours, you must be a member of the PIMLAdmins group. Otherwise, the Tour
Configuration dialog box opens in read-only mode.

PI Manual Logger User Guide 55

Create and Configure Tours

The Tour List toolbar options are listed in the table below.
Tool Description

Toggle the Search Options pane on and off.

Create a new tour.

Delete the selected tour. If you click Yes at the prompt, PI Manual Logger
deletes all tags in the tour, their associated attributes, and the tour name from
the PI Manual Logger database.

Caution: You cannot undo this operation. There is no way to retrieve

deleted tours.
Open the selected tour in the Tour Configuration dialog box, described in
section Configure a Tour (page 58).
Save a copy of the selected tour. This is useful when you want to build a tour
from a predefined template.
Close the Tour List pane.

56
 Create a Tour

Create a Tour
To create/edit tours, you must be a member of the PIMLAdmins group. To create a new tour:

1. Click .
2. The PIML Tour Creation Wizard appears. You can either create the tour using this
wizard, or check Skip this wizard and click Next to open the New Tour dialog box.
If you skip the wizard and proceed to the New Tour dialog box, complete the boxes in
the dialog box to define the tour.

Tour Name: Blank or duplicate tour names are not permitted.

Description: A tour description is optional.
Full Access Group: A group that can access tour runs with full permissions. Group
members that are assigned here can modify the tour, enter and review data for the
tour, and delete tour runs for this tour. For details about users and permission groups,
see section Managing the User Database (page 181).
Data Entry Only Group: A group that can access the tour with data entry only
permissions. Group members assigned here can only enter and modify tour data.
They cannot delete tour runs from the PI Manual Logger database.
Notes: Any static text information that you want to associate with the tour.
Click OK to create the new tour and open the Tour Configuration dialog box.
If you choose to complete the PIML Tour Creation Wizard, click Next on the PIML
Tour Creation Wizard dialog box, fill in the information, and click Next as necessary
until the tour is defined. The benefit of using the PIML Tour Creation Wizard is that
there is a prompt for you to add tags to your tour through the Tag Search dialog box. If
you create a tour with the New Tour dialog box, you need to take additional steps to add
tags to the tour. See section Configure a Tour (page 58).

PI Manual Logger User Guide 57

Create and Configure Tours

Configure a Tour
Open a tour from the Tour List dialog box to view its configuration in the Tour
Configuration dialog box.

The Tour Configuration dialog box consists of four panes: the central pane with four tabs
for tag configuration, the Tour Info pane, the Tag Attributes pane, and the Tag List View
pane. You can close the Tour Info pane, and close or change the width of the Tag Attributes
and Tag List View panes. To re-display these panes, click . For more information about
the Tour Configuration dialog box, see section Tour Definition Panes (page 58).

Tour Definition Panes

In the Tour Info pane, view and manage tour information, including the tour name and
description and these additional features:
User permission groups, section Manage the User Database (page 181).
Comments, section Comments (page 69).
Schedules, section Define Data Collection Scheduling (page 72).
Configure tags for collection in the central pane with four tabs.
Details for the selected tag in the central pane appear in the Tag Attributes pane.
A list of tags currently included in the tour appears in the Tag List View pane.

58
 Configure a Tour

Tour Definition Toolbar

The following table lists the functions that are available in the Tour Configuration dialog
box toolbar.
Function Description
Go to the first tag in the sequence.

Go to the previous tag in the sequence.

Enter a tag number in the sequence.

Go to the next tag in the sequence.

Go to the last tag in the sequence.

Add new PI tags. See Section Add Tags to a

Group (page 88).
Remove the selected tag.

Display or hide panes and display overviews

for scheduling..
Show System Digital States (page 93).

Reorder tags.

Save the tour.

Close the tour.

PI Manual Logger User Guide 59

Create and Configure Tours

Tag List View Options

The Tag List View pane displays the tags currently included in the tour. The following
functions are available when you right-click a tag or group in the Tag List View pane as
shown below.

Function Description
Add new PI tags Opens the Tag Search dialog box to select tags to add to the
tour. See Section Add Tags to a Group (page 88).
Show Trend Opens the PI Manual Logging Trend dialog box to display
trend information for the selected tag.
Collapse all Displays only the root tags and groups in the tree.
nodes
Expand all nodes Displays all groups and tags in the tree.
Tag Group Editor Opens the Tag Group Editor dialog box for editing/creating tag
groups.
Reorder Opens the Reorder Tag Sequence dialog box where you can
rearrange the order of tags in groups.
Import from Opens the Please Select a PI Module dialog box where you
Module can select modules to import.
Database
Import from a Opens the Pick a Tour dialog box where you can select a tour
tour of tags to import into the current list.
Save as a new Saves the current tour under a new name.
tour
Delete this node. Deletes the currently selected tag/group.

60
 Configure a Tour

Set Tour Options

Use the Tour Options dialog box to specify a tour's edit options during data entry. To open
this dialog box, click Tour Options in the Tour Info pane.

General Tour Options

Default current comment to last entered comments
Select for the comments for the current tag value to default to the last available comment for
that tag saved in the PI Server.
Write comments to both annotation and comment tag (if configured)
Select for PI Manual Logger to record comments in the annotation and comment tag, if the
comment tag is configured. For details, see section Comments (page 69).
Manual data must be submitted for approval
Select for users in the data entry group to be able to submit manual data for later approval
before they are sent to the PI Server.
Confirm work request generation before saving
Select for PI Manual Logger to require confirmation from the user before creating a work
request in response to a limit violation.
Display confirmation after sending to PI
Select for PI Manual Logger to display a confirmation dialog box showing the number of tags
that were sent to the PI Server.
Default current tag value to last entered value
Select for the current tag value to default to the last available value for the tag saved in the PI
Server.
Warn if tour run is incomplete
Select for PI Manual Logger to issue a warning when users close an incomplete tour run.
Data Entry Only Group can send data to PI
Select to enable users in the Data Entry Only group to send collected data to PI tags.
However, they are still prohibited from performing other tasks only permitted to members in
the Full Access group, such as managing tours or users. For details about setting tour group
permissions, see section Associate a Tour with a User Group (page 185).

Note: If the Data Entry Only group and Full Access group are identical, this option has
no effect. You must deselect this option in order for the Manual Data must be
submitted for approval option to be effective.

Create annotation to record user name when sending data to PI

Select for PI Manual Logger to create an annotation together with the PI tag value when
sending manual data to the PI Server. After the annotation and tag value are sent to the PI
Server, you can view them with the built-in Annotation viewer inside PI Manual Logger in
addition to the PI Manual Logger Trend control. You can also use PI ProcessBook, PI
DataLink, or other PI client tools to retrieve and view the recorded user name.

PI Manual Logger User Guide 61

Create and Configure Tours

Prompt before sending data to PI

Select for PI Manual Logger to prompt users for confirmation before sending data to the PI
Server.
Overwrite existing PI data instead of insert duplicates
Select for PI Manual Logger to overwrite existing PI data at the same timestamp. Deselect for
PI Manual Logger to insert the new value with the same timestamp, causing multiple events
with the same timestamp in PI data. OSIsoft recommends that you choose to overwrite
existing PI data.
Auto Send Data to PI
Select for manually entered data to be sent to the PI Server when a tour run is created and
closed. For mobile devices, any data in tour runs is sent to the PI Server after the tour runs are
transferred from the devices to the host.

Notes: In order for this option to be effective, PI Manual Logger AutoSync must not be
configured.

If you have selected the Manual Data must be submitted for approval option, only
tours that are in Approved status will be automatically sent to the PI Server.

Manage tag order sequence manually

Select to allow manual reordering of tags as they appear in the Tag List View independent of
membership in tag groups. This allows operators to take readings in a certain walking
sequence based on the order in which the tags appear on the mobile device.
For a PIML 1.4x tour that has been migrated with the Keep tag sequence order and
disregard group order Migration Tool check box selected, the Tour Option ‘Manage Tag
Order Sequence manually’ option is automatically set to True allowing users to manually
sequence tags. See the Tour Migration (page 195) appendix for details about migrating tours.
Signature required for each tour run save (on mobile device)
Select to require users entering data in mobile devices to provide a handwritten signature
when closing and saving a tour run. Handwritten signatures then appear in the Tour Run
History dialog box after they are transferred into the master SQL database.
Display previous values in data entry dropdown (on mobile device)
Select for all previous values cached on the handheld device to be added into the data entry
drop-down list on the device so that the user can select them.
Navigate through due tags only (on mobile device)
Select for the navigation tools, described in Navigation Tools (page 155), to display only the
tags that are due for collection. As operators navigate through tags to enter data during a tour
run, only those tags that are due for collection are listed. Operators can also press Enter after
entering a value to advance to the next due tag.
If operators need to see a tag that is not due, they must click the Group tab, select the tag, and
click Go.
Automatic pop-up display of Operator Instructions before data entry (on mobile device)
Select for operator instructions to open automatically when a tag is accessed on a mobile
device.

62
 Configure a Tour

Timestamp Tour Options

Default Tour Time to the Current Timestamp
Select for PI Manual Logger to use the current time as the tour timestamp. Deselect for the
tour's timestamp to default to the whole hour unless it is within 15 minutes of the next hour;
then it defaults to the next whole hour.
Allow Tour timestamp to be edited
Select to allow users to edit the tour's timestamp. This option is applicable only to the Data
Entry Only group for the tour. Users belonging to the tour's Full Access Group always have
permission to edit the tour and tag timestamps.
Default Tag Time to the Current Timestamp
Select for the timestamp for each data point to default to the current time.
Default Tag Time to Tour Timestamp
Select for the timestamp for each data point to use the same time as the tour timestamp by
default. If the tag timestamp does not default to the tour timestamp, it uses the PC or mobile
device's clock time.

Note: This option may be useful when you enter values for lab samples. For example,
the ASTM lab analysis for the Kerosene cut in a Crude unit has multiple data
values, but all with the same timestamp.

Allow Tag timestamp to be edited

Select to allow a user to edit the timestamp for each data point. This option is applicable only
to the Data Entry Only group for the tour. Users belonging to the tour's Full Access Group
always have permission to edit the tour and tag timestamps.

Note: If no timestamp is entered, the default is the tour timestamp. The timestamp is
populated when you navigate to the next tag or close the Data Entry screen.

PI Manual Logger User Guide 63

Create and Configure Tours

Limit Checks Tour Options

Use the Limit Checks tab to set the level of limit violation check. First decide whether you
want an action to occur automatically when a limit is violated. If you do, select the
Automatically perform action option. Conversely, if you want the user to be prompted for
action when a limit is violated, select the Prompt user for action option.
If you select Automatically perform action, decide whether you want the value always to be
accepted or always be rejected. Select the Accept Value or Reject Value option accordingly.
If you want the user to be alerted visually that the automatic action has taken place, select the
Show visual indication to user checkbox.

Note: The visual indication is a color change to the tag's row on the Data Entry Sheet
page for the tour run.

For details about using limit checking for data validation, see Set Data Validation Limits
(page 82).

Note: Regardless of which limit checking levels you select in the Tour Options dialog
box, limit violation is always recorded in the auditing and message log system in
PI Manual Logger.

Barcode Tour Options

Barcode, if assigned, must be scanned or manually entered before data entry is allowed.
Select to require users to scan or enter a barcode for any tag or tag group that has a barcode
association before they can access the Data Entry screen. For more information about using
barcodes, see section Use Barcodes with Tags and Tag Groups (page 67).
Display barcode enter screen before data entry screen
Select to display the barcode screen as the initial screen on the mobile device when a user
starts a new tour. After scanning a barcode, the tag associated with that barcode is prompted
for data entry. After the data for that tag is entered, the scan barcode screen appears again.
Use barcode scanning for navigation instead of data entry on data entry screen
Select this option so that when you scan a barcode on the device data entry screen, PI Manual
Logger navigates to a tag that is associated with that barcode instead of recording a value for
the current tag. This option is available only for specific Symbol devices. See section
Supported Scanning Devices.

Notes: For a fully barcode-based system, where tags are aliased with barcodes, you can
set up a single tour to include all tags for which data is to be collected and data
entered without following the sequence in which tags are configured in the tour.

64
 Configure a Tour

Other Tour Options

On the Other tab, specify the format for data that is in number.number.number format.
For example, if you choose Feet.Inch.sixteenth, then the entry 12.5.8 means 12 feet, 5
inches, and 8 sixteenths of an inch. This entry results in a final value of: 12 + (5 + 8/16)/12 =
12.4583 feet.

Note: During data entry, users must enter a number for the sixteenth or eighth value,
even if it is 0 (zero). For example, for a measurement of exactly 7 feet 6 inches,
enter 7.6.0.

PI Manual Logger User Guide 65

Create and Configure Tours

Configure Tags
When a tag is selected in the central pane of the Tag Configuration dialog box, you can
configure the attributes for that tag. These attributes include a comment tag, conditional
manual data entry specifications, tag scheduling, and so on. For information about creating
tags manually, see Appendix Manual Creation of PI Tags (page 229).

Select Tags

You can include a tag only once in a tour, but you can use the same tag in more than one tour.
You can enter only one value for a tag during a single tour run.
To select the tags to collect manually:
1. In the central pane of the Tour Configuration dialog box, select the Tag Configuration
tab.

2. Click or click Add by the Tag Name box. The Tag Search dialog box appears.

Note: PI Manual Logger supports the following Point Types: Float16, Float32,
Float64, Int16, Int32, Digital, and String. Timestamp is also supported, but it
cannot be trended.

66
 Configure Tags

3. Execute a search and select one or more tags.

Note: Only the user sending tour run data to the PI Server must have data write
access to the tag. Data entry users only need read access. For details, see
section "Manage the User Database (page 181)."

4. Double-click the tag or tags that you want to select in the list, or select one or more tag(s)
and click OK.

Use Barcodes with Tags and Tag Groups

If your mobile device is equipped with a barcode scanner, you can use a barcode as an alias
for a tag name. You can also assign a barcode to a tag group (such as a piece of equipment,
an area, or a building) by assigning it to the first tag in the group.
To configure PI Manual Logger to collect tag group data when a barcode is scanned, enter a
barcode in the Barcode box for the first tag (by tag sequence) in the group on the Tag
Configuration dialog box.
During data entry on a PC, tags are grouped by the selected tag group when you use the tag
group view.
When you scan a barcode, the appropriate data entry screen appears on the mobile device.
After you enter data, the data entry screens for the remaining tags appear in sequence for that
tag group.

Note: PI Manual Logger Mobile supports integrated barcode scanning on selected

Symbol Windows Mobile barcode scanning devices. For a detailed list of
supported devices with integrated barcode scanning, see section Supported
Scanning Devices.

You can use the Tag Group and Barcode box to group tags in a tour even if you are not
actually using barcodes or a scanner.
For example, suppose you are collecting tags in buildings A, B, C, and D. You can group the
tags so that when you enter A at the Barcode/Tag Group prompt, tags for building A are
displayed. After you follow the sequence of tags for building A, PI Manual Logger prompts
you for another barcode or tag group. When prompted for a barcode, you can enter another
building letter and go to the first tag in that group.
There is no limit to the number of groups or the number of tags within a group.
For details about configuring behavior for barcodes, see section Barcode Tour Options (page
64).
For details about using barcodes with mobile devices, see section Scan Barcodes with Mobile
Devices (page 150).

PI Manual Logger User Guide 67

Create and Configure Tours

Barcode Overview
Use the Barcode Overview feature to review all barcodes defined in a tour, or to print out
one of the predefined types of barcodes. To open the Barcode Overview dialog box,
click and select Barcodes Overview, as shown in the following figure.

In the Tour Barcode Overview dialog box, the available barcode types are 39 and 128, with
128 being the default. Click Barcode Type to specify the appropriate type for auto-
generation and/or printing purposes.
Click Print Barcodes>Print, as shown in the following figure, to print barcodes defined in
the tour. After making the selection to print the barcodes with a readable barcode string or
without the string, a Page Setup dialog box prompts you to select your paper, orientation,
and margin specifications. After making these selections, click OK. A Print preview
window appears and you can view the page layout and print.

Click on the Tour Barcodes Overview dialog box to generate barcodes

automatically, based on tag names. Code 128 is the default code when you auto-generate or
print barcodes.

68
 Comments

Comments
A comment allows the user, and in certain situations, requires the user to enter a string
comment detailing extra information about the value. For example, if a value is outside limits,
the tour creator can require a comment that explains why.

Comment Types

You can enter comments for the tag value being collected, a group, or the whole tour. Use
comments to capture operator comments as part of the manual data collection. Comments are
stored in either or both of these two ways:
PI Annotations
Comment tags - String PI tags
All tag comments are stored in PI Annotations for the entered value. It is recommended that
you choose this method for tags since you do not have to configure a special PI String tag to
hold the comment.
If you use comment tags, such as the comment tags in PI Manual Logger 1.x versions-you,
can associate a PI String tag with a tag, tag group, or a whole tour. Comment tags associated
with tour tags have the same timestamp as the process value tag. Tour comments and group
comments are not sent to the PI Server if they are not associated with a PI String tag through
the Comment Tag association. Tour and group comment tags have the same timestamp as the
Tour Run timestamp.

Note: If you configure a comment tag for a process value tag, the comment is stored in
the comment tag, as well as PI Annotations associated with the entered value.

During data entry, PI Manual Logger stores comments in the PI Manual Logger database.
After the comments and values are sent to the targeted PI Server, you can set up reports in
Excel (using PI DataLink or other PI client tools) to retrieve process values and the associated
comment entries from the PI Server.

PI Manual Logger User Guide 69

Create and Configure Tours

Comment Templates

You can pre-define comments, which users can use during data entry. Pre-defined comments
are called comment templates.
To view or modify the list of pre-defined comment templates, click Tools>Comment
Templates. The Comment Template Builder dialog box appears.

Comment templates are globally accessible. All tours in the same database share the same set
of comment templates.
You can also import existing PI Reason Codes into comment templates.

After you select a node in the reason tree, the node is imported as the template name, and all
its direct sub-nodes are imported as template entries.

70
 Comments

The PI Reason Tree can be shared among multiple PI applications that you can edit in PI
SMT version 3.1.2.1 or later.

PI Manual Logger User Guide 71

Create and Configure Tours

Define Data Collection Scheduling

After you have selected tags for the tour, define conditional data collection scheduling.
To define conditional data collection scheduling:
1. In the Select a Tour dialog box, double-click a tour in the Tour List pane. The Tour
Configuration dialog box for that tour appears.
2. Schedule data collection for the selected tag, the selected tag's tag group, or the entire
tour.
For a Tag: On the Tag Configuration tab, click Set by the Collection Scheduling
box.
For a Tag Group: On the Tag Configuration tab, click Set by the Collection
Scheduling box.
For a Tour: In the Tour Info pane, click Set by the Tour Scheduling box.
In a typical data collection process, you may have some tags for which data is collected
every hour, and other tags that are only collected once a shift or once a day. You can set
up a single tour with many points that have different collection frequency attributes.
3. In the Data Collection Scheduling dialog box, choose Clock Scheduling. Select No
Scheduling to remove the previous clock scheduling.

4. If you have selected Clock Scheduling, click Set. The Recurrence Clock Scheduling
dialog box appears. Set the recurrence pattern for the selected tag, the tag group, or the
entire tour. You can set the recurrence pattern using one of five time spans: hourly, daily,
weekly, monthly, or yearly. Examples of recurrence patterns follow this procedure.

72
 Define Data Collection Scheduling

5. After you set the recurrence pattern, click OK to close the Recurrence Clock
Scheduling dialog box.
The Parsed Spec section shows the user-defined recurrence clock scheduling information
in machine-readable text format.
The Descriptions section shows a brief description of the specified recurrence clock
scheduling.

6. To save your changes to the tour, click .

Choose from the following recurrence patterns. Note that CMDE scheduling overrides all
collection scheduling, but can be used in CMDE to defer to clock scheduling.
Hourly Scheduling: In hourly scheduling, you can specify the pattern of schedules recurring
one to every several hours. The start time and end time need to be on the same day for hourly
scheduling to take effect.
Example: You want data to be collected from a point, twice a day starting at 5:00 a.m. You
want the operator to have enough time, five hours, to collect the data. Specify the collection
scheduling fields for the group as follows:
Recurrence pattern: hourly.
Starts from: 5:00:00 a.m.
Ends on: 10:00:00 a.m.
Every: 12 hours.
With these settings, the group of tags is due for collection any time between 5:00 am – 10:00
am and 5:00 pm – 10:00 pm.
Scenario 1 The operator starts a tour run at 8:00 am. The Due icon is displayed for the
group and each tag within the group, meaning data needs to be collected.
Scenario 2 The operator starts a tour outside the window, 1:00 p.m., for example, then the
group is not due for collection and shows the Collected icon for the group, and the Not
Due icon on the desktop and on the mobile device, for each tag.
Daily Scheduling: In daily scheduling, you can specify the pattern of schedules recurring on
a daily basis, or every several days. The start and end times can be either on the same day or
different days. If the end time is on the next day, any time that falls between the start time and
the next day end time will be prompted for data collection, such as midnight between the
scheduled days.
Example: You want data to be collected from a point, once a day starting at 3:00 p.m. You
give the operator six hours, to collect the data.
Recurrence pattern: daily.
Starts from: 3:00:00 p.m.
Ends On: 9:00:00 p.m.
Every: 1 day.

PI Manual Logger User Guide 73

Create and Configure Tours

Example: You want to schedule a group of tags to be collected every 4 days on both the day
and night shift on that first day. Given that a tag cannot be included more than once in a
single tour, there are two ways to handle this.
Method 1: Create two separate tours, one for the morning shift and one for the evening shift.
Advantage: It is easier to visibly recognize the hours in which tags need to be collected.
Disadvantage: This can lead to schedules, tag configuration, etc. getting out of sync,
although this may be a desired feature.
Method 2: Use CMDE with Clock Scheduling to control it.
Advantage: You need to maintain only one tour.
Disadvantage: This may appear to be slightly more confusing at first.
To do this scheduling with CMDE, follow these two steps:
1. For the group, define the following CMDE (Conditional Specification):
if( ((TourTime() - "January 1, 2009") % 4) = 0,
ClockSchedule(), Skip())

Note 1: Instead of January 1, 2009, use the date from which the four-day shifts start.
Note 2: The '%' is a Modulus function, which means in this case, that every 4 days,
starting from January 1, 2009, check the clock scheduling to see if the tags are due.
2. Define Clock Scheduling (CS) for the tour along these lines:
Starts from: 1/1/2009 at 4:00:00 AM
Ends on: 8:00:00 AM
Recurrence Pattern: Hourly
Every: 12 hours

Note 1: This Clock Scheduling means that between the hours of 4am-8am and 4pm-8pm,
the tags are to be collected.
The use of CMDE in conjunction with the Clock Scheduling results in the tags within the
group being collected between the hours of 4am-8am and 4pm-8pm every 4th day, starting
from January 1, 2009.

Weekly Scheduling: On weekly schedules, you can specify the week days to collect the data.
You can also specify the weekly frequency of such collection.
Example: You want data to be collected from a point, on Monday and Friday, starting at 6:00
a.m. You give the operator three hours, to collect the data.
Recurrence pattern: weekly
Starts from: 6:00:00 a.m.
Ends on: 9:00:00 a.m.
Recurs every: 1 week
Week days: Monday and Friday.

74
 Define Data Collection Scheduling

Monthly Scheduling: On monthly schedules, you can specify your collection schedules in
two ways: By Days or By Weekdays. When By Days is selected, you can specify the
numeric days in the month to collect the data. When By Weekdays is selected, you can
specify the weekdays in the month the data is due for collection. You can also specify the
monthly frequency for both types of monthly scheduling.
Example 1: You want data to be collected from a point, on the first and the 15th day of each
month, starting at 6:00 a.m. You give the operator three hours, to collect the data.
Recurrence pattern: monthly.
Starts from: 6:00:00 a.m.
Ends On: 9:00:00 a.m.
Select the By Days option and choose Day 1 and Day15. To do this every month, in
the Of Every Month field, enter 1.
Example 2: You want data to be collected from a point, on the first Monday and the last
Wednesday of each month, starting at 6:00 a.m. You give the operator three hours, to collect
the data.
Recurrence pattern: monthly.
Starts from: 6:00:00 a.m.
Ends On: 9:00:00 a.m.
Select the By Week Days option. In the The field, select first and Monday and click
. Then repeat to add the last Wednesday. To do this every month, in the Of Every
Month field, enter 1. Click to remove a weekday item from the list.
Yearly Scheduling: Yearly schedules are similar to monthly schedules: you can specify your
collection schedules By Days or By Weekdays. When By Days is selected, you can specify
which days in the month the data is due for collection. When By Weekdays is selected, you
can choose a weekday specification and add it to the specification list by clicking the Add
button . Click the Delete button to remove the selected weekday item from the
specification list. You can also specify the yearly frequency for both types of yearly
scheduling.

The following examples show how tag scheduling priority affects when tag data is due. Note
that tags have priority over tag groups with respect to clock scheduling.
Example 1:
Tour Scheduling Definition:
Group1 - Weekly on Mondays, Wednesdays, and Fridays between 4-6pm
Tag1a - None
Tag1b - Daily between 4-6pm
Group2 - Weekly on Tuesdays between 4-6pm
Tag2a - None
Tag2b - None

PI Manual Logger User Guide 75

Create and Configure Tours

Scenario Tour Run #1 for Example 1:

Actual Due Status During Tour Run at 5:15pm on Wednesday:
Group1 - All Due ( )
Tag1a - Due ( )
Tag1b - Due ( )
Group2 - All Not Due ( )
Tag2a - Not Due ( on the PC, on the mobile device)
Tag2b - Not Due ( on the PC, on the mobile device)
Scenario Tour Run #2 for Example 1:
Actual Due Status During Tour Run at 4:45pm on Tuesday:
Group1 - Something Due ( )
Tag1a - Not Due ( on the PC, on the mobile device)
Tag1b - Due ( )
Group2 - All Due ( )
Tag2a - Due ( )
Tag2b - Due ( )
Example 2:
Tour Scheduling Definitions:
Group1 - Weekly on Tuesdays and Wednesdays between 4-6pm
Tag1a - None
Tag1b - Daily between 4-6pm
SubGroup1 - Weekly on Wednesdays between 4-6pm
SubTag1a - None
SubTag1b - None
Group2 - Weekly on Tuesdays between 4-6pm
Tag2a - None
Tag2b - None

Scenario Tour Run #1 for Example 2:

Actual Due Status During Tour Run on Tuesday at 5:30pm:
Group1 - Something Due ( )
Tag1a - Due ( )
Tag1b - Due ( )
SubGroup1 - All Not Due ( )
SubTag1a - Not Due ( on the PC, on the mobile device)
SubTag1b - Not Due ( on the PC, on the mobile device)
Group2 - All Due ( )
Tag2a - Due ( )
Tag2b - Due ( )

76
 Define Data Collection Scheduling

Scenario Tour Run #2 for Example 2:

Actual Due Status During Tour Run on Wednesday at 4:30pm:
Group1 - All Due ( )
Tag1a - Due ( )
Tag1b - Due ( )
SubGroup1 - All Due ( )
SubTag1a - Due ( )
SubTag1b - Due ( )
Group2 - All Not Due ( )
Tag2a - Not Due ( on the PC, on the mobile device)
Tag2b - Not Due ( on the PC, on the mobile device)
Scenario Tour Run #3 for Example 2:
Actual Due Status During Tour Run on Wednesday at 10:00am:
Group1 - All Not Due ( )
Tag1a - Not Due ( on the PC, on the mobile device)
Tag1b - Not Due ( on the PC, on the mobile device)
SubGroup1 - All Due ( )
SubTag1a - Not Due ( on the PC, on the mobile device)
SubTag1b - Not Due ( on the PC, on the mobile device)
Group2 - All Not Due ( )
Tag2a - Not Due ( on the PC, on the mobile device)
Tag2b - Not Due ( on the PC, on the mobile device)

PI Manual Logger User Guide 77

Create and Configure Tours

View Tag Schedules in Selected Tour

The Tour Scheduling Overview dialog box shows all the defined tour, tag group, and tag
schedules in the selected tour. In this dialog box, you can view, modify, and delete schedules.
To open the Tour Scheduling Overview dialog box, click > Schedule Overview.

Insert Operator Instructions

Use the Operator Instructions box on the Tag Configuration tab to enter tag attributes. For
example, the instruction for a meter that needs recalibrating could be:
Meter needs recalibrating; subtract 50 from reading before
entering data.
Or you can include an instruction to the person entering data, such as:
Verify repair to steam valve 31.
You may also include instructions for actions to take for High and Low readings. For
example:
BELOW RANGE: Lean side corrosion

ACTION: Decrease steam to circulation ratio

ABOVE RANGE: High sales gas sulfur

ACTION: Increase steam to circulation ratio

TARGET: Too much H2S in the lean leads to sour sales gas. Too
little H2S leads to corrosion in the hot lean sections.

78
 Insert Operator Instructions

It is possible to insert a hyperlink to a file or an HTTP web site or an FTP site in the operator
instructions. Multiple hyperlinks can appear in operator instructions used for tour runs
executed on a PC, and the operator can choose the hyperlink to open. Operator instructions
for mobile devices can contain only one working hyperlink.
When the operator executing a tour run selects a tag with operator instructions that contain a
hyperlink, the following actions take place:
On a PC: the operator instructions are always visible in the window. The operator can
choose from the hyperlinks, if there are more than one, and open it. Internet Explorer
opens automatically when the link is clicked.
On a mobile device: If the Tour Option "Automatic pop up display of Operator
Instructions..." is True, the operator instructions open automatically and display the
hyperlink. The operator can do the following:
Click Go to Link, accessing the web site if the device has internet access, or opening
the file if the file exists on the device.
Click Cancel if it is not necessary to view the hyperlink.

Note: If the operator enters a value for a tag and then accesses the tag a second
time, the operator instructions do not open automatically. However, the
operator can click to display them again.

Use the standard syntax of a Universe Resource Identifier (URI) for a hyperlink. Refer to the
Uniform Resource Identifier: Generic Syntax
(http://www.ietf.org/rfc/rfc3986.txt) web site for additional information
about syntax.
The following are syntax examples:
http://<host_name> . Example: http://osisoft.com This hyperlink
accesses the OSIsoft main web site.
ftp://ftp.<server_address> Example: ftp://ftp.gimp.org. This
hyperlink accesses the currently valid FTP site at gimp.org.
\<path\file_name> or file:\\\<path\file_name>
Examples: \MY DOCUMENTS\my_file.txt. This hyperlink opens the file called
my_file.txt located in the My Documents folder of the mobile device.
\MY DOCUMENTS\Business\my_file.txt. This hyperlink opens the file called
my_file.txt located in the My Documents\Business folder of the mobile
device.
file:///c:\<file_name> This link opens a file located on a PC. Example:
file:///c:\my_file.txt. This hyperlink opens a file called my_file.txt
located at the root of drive C:
file:///\<path\file_name> Example:
///MY%20DOCUMENTS\my_file.txt. This hyperlink opens the file called
my_file.txt located in the My Documents folder of the mobile device.

PI Manual Logger User Guide 79

Create and Configure Tours

Note these guidelines for constructing a hyperlink:

If the path or file name contains spaces, verify that these are replaced with the characters
%20.
For links and files on the PC, OSIsoft recommends that you open the file or web site in
Internet Explorer, copy the hyperlink, and then paste it into the Operator Instructions
box. PI Manual Logger converts it appropriately. Example:
http://portal.osisoft.com/sites/Development/ClientApplicati
ons/ManualLogger/Shared%20Documents/Presentations/OperatorI
nstructions/Fire%20Extinguisher%20Inspection%20Procedures.h
tm PI Manual Logger may prompt you for authentication.
For links and files on the mobile device, OSIsoft recommends that you first test opening
the file or web site in Internet Explorer/Pocket Explorer on the device and enter the link
in the Operator Instructions box the same way you opened it on the mobile device.
For a file schema, if you type in the link to the file manually, instead of copying the link
from Internet Explorer as described in the previous bullet, be sure to use the third forward
slash, which acts as a delimiter ( / ).
For instructions that you want to display on a mobile device, you can enter lines of text or
a hyperlink. If you include text and a hyperlink, or multiple hyperlinks, all entries appear
as text.
In the Tour Options you can specify whether the operator instructions appear
automatically on the mobile device. The default is for the instructions to open when the
operator accesses the tag that has them.
Although you can link to and display a file on the mobile device, OSIsoft recommends
that you link to an HTTP or FTP site where you can maintain a single file, in a central
location, accessed by all devices. Depending on the file type, a mobile device may, or
may not, return the operator to PI Manual Logger after the file is closed. The operator
may need to redisplay PI Manual Logger manually.
You can link to any file for which there is an application that can display it, for example,
.jpg or .png graphic files, .txt text files, and so forth.
After you enter a hyperlink, click it to verify that the accessed file or site opens.

80
 Define Data Collection Conditional Specification (CMDE)

Define Data Collection Conditional Specification (CMDE)

Use Conditional Manual Data Entry (CMDE) to add a calculation to a tag or group to
determine if it should be due for collection. This equation uses previous values of the current
tag or current values of other tags to do mathematical calculations on them based on a set of
supported functions. For more information see appendix Conditional Manual Data Entry
(page 215).
To add a CMDE formula, click the Tag Entry Options tab in the central pane of the Tag
Configuration dialog box. Write the formula in the text box below Conditional
Specification, and click to verify the formula.

Set Tag Formats

On the Tag Entry Options tab in the Tag Entry Preformat box, assign a format for the
selected tag. This is especially helpful when using handheld devices to enter data, as users do
not have to enter non-numerical dots. For example, if the Tag Entry Preformat for a tag is
##,###.## and a user enters a 1234567 for that tag, then the final value for that tag is
12,345.67.

PI Manual Logger User Guide 81

Create and Configure Tours

Set Data Validation Limits

To generate warning messages during data entry, specify data validation limits. Select the
Data Validation tab on the central pane of the Tag Configuration dialog box and set the
appropriate limits.

Specify limits by quantity or PI tags:

To specify limits by quantity, enter quantity values in the limit boxes.
To specify limits by PI tags, click Set by the box of a limit, then select a tag from the Tag
Search dialog box.

Note: Since PI Manual Logger supports limits from PI tags, these limits may come from
an external data source. For example, PI tags configured to use RDBMS Interface
or OLEDB COM Connector can access data limits residing in a relational
database.

The delta limit is used to check the rate of change from the last archived value. A tag on
multiple tours may have different limits in each tour. For details about configuring limit
checking behavior, see Limit Checks Tour Options (page 64).

Note: It is possible for multiple limits to be violated.

82
 Define Trigger Actions

Define Trigger Actions

A trigger action is an operation that happens when an entered tag value is outside the selected
limit. To define a trigger action for a specific tag limit: (1) on the Tour Configuration dialog
box, select the Data Validation tab and (2) click to define your set of actions for a
validation limit.

Note: After you define the actions for a limit, the Actions icon appears next to that
limit.

Trigger actions are used on both desktop and mobile device applications. You can combine
those actions and use them for a given limit specification.

On the General tab, specify the following actions when a limit has been violated:
Override Tour Limit Violation Action: Select this check box to override the specified
tour level limit action to either accept or reject the value that violates this limit.
Require Signature on device: Select this check box to prompt the operator to sign the
data before navigating to a different tag on the data entry screen.
Require Comment: Select this check box to require the operator to enter a comment
before the value can be accepted.

Prompt Message: Select this check box to display a dialog box with instructions or
warnings for the operator.

PI Manual Logger User Guide 83

Create and Configure Tours

The signature is associated with the manually entered value. If the operator changes the
value, the signature is discarded. If the new value violates the specified limit, the operator
may be prompted to sign the new data.
The signatures are stored as images inside the mobile database on the device.

Note: Frequent use of this feature can have significant impact on your mobile
database size and performance.

The required signature action is currently only supported on Windows Mobile devices.
On Windows XP/Vista Mobile PCs, this action is ignored.

84
 Define Trigger Actions

On the Work Request tab, you can select Generate Work Request as a trigger action. This
defines an automatically generated work request if a value violates the specified limit. If
selected, a work request is automatically generated and put into the Work Request queue for
later review.

If you have multiple trigger actions defined in multiple places in a tour, you can view all the
trigger actions defined inside the tour in the Trigger Actions Overview dialog box. To open
this dialog box, in the Tour Configuration dialog box, click and select Trigger Actions
Overview, as shown below.

PI Manual Logger User Guide 85

Create and Configure Tours

The Trigger Actions Overview dialog box appears. Double-click any of the listed trigger
actions to edit the selected action.

86
 Group Tags Within a Tour

Group Tags Within a Tour

You can group tags within a tour. The tag group can be a piece of physical equipment or a set
of measurements for a process that are usually measured together. You can define a
hierarchical list of tag groups to logically group the tags in a tour.
To create a tag group, click in Tag List View pane The Tag Group Editor dialog box
appears.

Create, rename, delete, and rearrange tag groups in the Tag Group Editor dialog box.

To assign a barcode to a tag group, select the group you want, click , enter the barcode in
the text box that appears, then click Apply.
To rearrange the tag group structure, drag-and-drop the group icons or use the arrow buttons.

PI Manual Logger User Guide 87

Create and Configure Tours

Add Tags to a Group

To add tags to the group follow these steps:
1. Select the group from the Tag List View's Tree View, so that the Tag Group
Configuration tab is visible in the Tour Configuration dialog box.
2. Add tags to the group in one of the following ways:

Click in the Tool Definition toolbar at the bottom of the Tour Configuration
dialog box.

Click on the tool strip in the Tree View.

Right-click in the Tree View and select Add new PI tags.
3. In the Tag Search dialog box, which appears, select the tags and click OK to add the
tags to the group.

Note: If you have not selected a group, the tags are added to the root level of the Tree
View.

Typically the first tag in a tag group represents the status of the equipment. This can be a
digital state, such as on/off, running/out of service, and so forth. To define conditional
specifications on collecting tags within a group based upon the status of a tag using CMDE,
see Appendix see Appendix Conditional Manual Data Entry (page 215).

88
 Import Tag Group Hierarchy

Import Tag Group Hierarchy

To import tag group hierarchy from an existing PI Module Database:
1. In Tag List View pane of the Tour Configuration dialog box, right-click in the Tree
View tab and select Import from Module Database.

2. To import from a PI Module Database, select a PI module in the dialog box. PI Modules
and sub-modules import as tag groups, and PI aliases import as PI tags that are designated
to be manually collected data.

PI Manual Logger User Guide 89

Create and Configure Tours

You can also import tags from other tours on different PI Servers. To do this, right-click in
the Tree View tab of the Tag List View pane and select Import from a Tour. More
specifically, follow these steps:
1. Create Tour A with tags from PI Server A.
2. Connect to PI Server B.
3. Create Tour B while connected to PI Server B.
4. Select Import from a Tour to copy Tour A tags into Tour B.

90
 Reorder Tags and Tag Groups

Reorder Tags and Tag Groups

The tag sequence defines the order in which data is to be collected in a tour. To rearrange the
order of tags in the tour, in the Tag List View pane of the Tour Configuration dialog box,
right-click in the Tree View tab and select Re-order or click the Reorder Nodes icon . In
the Reorder Tag Sequence dialog box that appears, select a tag and click the arrows / .

You can also drag-and-drop tags and tag groups in the Tree View tab of the Tag List View
pane.

It is possible to reorder the tags as they appear in the Tag List View independent of
membership in tag groups. This allows operators to take readings in a certain walking
sequence based on the order in which the tags appear on the mobile device. Open the List
View tab. Select a tag, then click the number in the Order column as shown in the following
figure. Note that the Manage Tag Order Sequence Manually option must be selected in the
list of Tour Options (section General Tour Options (page 61)) before you can change the
order.

PI Manual Logger User Guide 91

Create and Configure Tours

For a PIML 1.4x tour that has been migrated with the Keep tag sequence order and
disregard group order Migration Tool check box selected, the Tour Option ‘Manage Tag
Order Sequence manually’ option is automatically set to True allowing users to manually
sequence tags.

92
 Set Tour Digital States

Set Tour Digital States

You can select states in the State set, which are associated with all the tags in a tour. Some
examples are: Meter Broken, Bad Data, Idle, Out of Service, Not Running, Equipment Off,
and Tagged Out.

Note: Always update digital states before running a tour.

To access SYSTEM States, click on the Tour Configuration dialog box. The Tour
System States dialog box appears.

You can associate digital strings for real and integer tags. For example, consider that during
lab data entry, you need to record digital strings for some real and integer data types. Some
lab tests result in values that range from 0-9, which are good test results, but at the same time
you need to record digital string values (such as bad input, milky, cloudy, turbid) as reason
codes for test failure.
To add digital states to a tour, select one or more states, right-click, and select Add
Selected. You can also double-click a SYSTEM digital state to add the state to the Tour
States List.
To hide digital states from the available digital states list, select the states, right-click, and
select Hide Selected.
To show all available digital states, right-click in the Available States pane and click
Show All.
You can sort the columns in the Tour System States dialog box to make it easier to find
the SYSTEM digital states.

PI Manual Logger User Guide 93

Create and Configure Tours

There are two types of digital states that can be included within a tour, SYSTEM and user-
defined (non-SYSTEM). The section above describes how to include SYSTEM digital states.
User-defined digital states are included through a different method.
If a point has been defined as a Digital Point Type with a non-SYSTEM specific Digital Set,
that point can be included within a PI Manual Logger tour, thus providing its values during a
tour run in addition to any SYSTEM digital states that were included in the tour. So, when a
tour is run, the tag value drop-down box displays the user-defined Digital States first, then the
SYSTEM digital states, that were included in the tour.

Within this example tour run, you can see the user-defined digital states first, and then the
SYSTEM digital states, that were included within the tour.

Note: The user-defined states do not show up when the Tour States button is clicked
from within the Tour Configuration dialog box.

94
 Set Tour Digital States

They can also be seen by navigating PIML > PI Tags and Digital States > PI Digital
States, but this method does not show the tour with which the digital state is associated.

PI Manual Logger User Guide 95

Create and Configure Tours

Display Trends

To display the trend for a tag, in the Tag List View pane select the tag and click , or right-
click the tag and select Show Trend.

Note: Trending does not include data from un-archived tour runs, including the tour run
in progress.

In PI Manual Logger trends, you can show annotations and events, and scroll through time
ranges.

In the figure above, three features are available on the menu bar:
Add Trace: Click to search and add new PI tags to the trend.
Revert: Click to revert the trend displayed to the initial time range.
Version: Click to view the version information of the PI Trend Library.

96
 Display Trends

To change the default time span for trends, select Tools > Preferences. In the User Options
dialog box that appears, set the time span in the Trending Options tab.

You can also right-click the trend to view a few additional options.

Choose Change Scale to change the y-axis scaling and time range.
Choose Revert to undo any changes and revert to the original trend settings.
Choose Scroll Bar to enable a scroll bar at the bottom of the trend to scroll the display
through adjacent time ranges.

PI Manual Logger User Guide 97

Create and Configure Tours

View All Work Requests

A work request is an internal request for follow-up work, such as a maintenance check,
preventative maintenance, repair, parts order, services, and so forth. Section Define Trigger
Actions (page 83) describes how to create a work request.
After you have completed tour runs on either a PC or a mobile device and synchronized to the
central PI Manual Logger database, you can select PIML>Work Requests to view the list of
work requests that were generated.

The Work Request Viewer appears.

On the Work Request Viewer you can:

View a list of work requests that have been collected.
Export the existing work requests that have been collected.
Delete selected work requests from the queue.
If you are a member of the administrative PI Manual Logger user group, you can clear the
entire work request list by clicking Clear.

98
 Work Offline

Work Offline
You have the option to disconnect PIML from the PI server and do these selected tasks by
working offline:
On the PIML menu, open the Message log, view PI tags and digital states, switch users,
and view work requests.
On the Tours menu, execute a tour run and collect data on the mobile PC, import a tour
run from a file, view/edit data in existing tour runs.
On the Mobile Devices menu, view device data for those handheld mobile devices that
are running.
On the Tools menu, specify and test a database connection and specify global options.
On the Offline menu, specify the Enterprise SQL Server, choose transfer options for the
mobile PC, and open the Offline Transfer Console.

PI Manual Logger User Guide 99

Chapter 5

View and Edit Tour Runs

A tour run is a set of values, statuses, comments, and associated timestamps taken for tags in
a tour.
To show tour runs:
1. Click Tours>Tour Run List (Manual Data Entry and Review). The Select a Tour
Run dialog box appears.
2. In the Tour List pane, select the tour you want.
3. The tour runs appear in the Tour Run List pane.

The tour run list columns are:

Tour Name
Tour Comments
Run Time Stamp
Operator

PI Manual Logger User Guide 101

View and Edit Tour Runs

Status: Shows the current status of the run. The available values are:
In Progress: Data entry has started but is not complete.
Submitted: Data entry is complete and is ready for review.
Archived: All non-empty values in the run have been written to the PI Server.
Completed: The run has been completed but the values have not been archived.
Queued: The run has been completed but contains future data that cannot be sent to
the PI Server yet.
Empty Tags

Note: Click any of the column headers to sort the tour and tour run lists.

The tour list is limited to items for which you have at least Data Entry permission. If you
have PI Manual Logger administrative privileges, you can select all tours. For details about
user permissions and groups, see User Groups (page 183).
The Tour Run tools are:
Tool Description
Toggle the Search Options pane on and off. You can search for tour runs
based on a number of options.

Create a new tour run. When you click this button, a New Tour Run dialog
box appears. Enter the timestamp you want and click OK to go to the Data
Entry Form (page 107).
Delete the selected tour run. If you click Yes at the prompt, PI Manual Logger
permanently deletes entries for all tags in the selected tour run from the
database.
Import a Tour Run data file from an XML file.

View the History of a Tour Run. (page 119)

Send data from the selected tour run to the PI Server.

Print either a blank data entry sheet or existing tour run data.

Open the selected tour run so you can modify or add values. For details, see
Data Entry Form (page 107).
Close the Tour Run List pane.

102
 Create a New Tour Run

Create a New Tour Run

To create a new tour run click . The New Tour Run dialog box appears.

PI Manual Logger User Guide 103

View and Edit Tour Runs

Enter Values for Tags in a Tour Run

Use the Data Entry dialog box to enter and edit values and timestamps for tags in a tour run.
The Data Entry dialog box appears when you create or edit a tour run (page 101).

Note: You must have at least Data Entry permission level to enter and edit tag values
and timestamps.

104
 Enter Values for Tags in a Tour Run

Data Entry Toolbar

The following functions are available from the Data Entry dialog box toolbar:
Tool Description

Go to the next or previous limit violation.

Move to the first tag in the sequence that is due for collection.

Move to the previous tag in the sequence that is due for collection.

Enter a tag number in the sequence that is due for collection.

Move to the next tag in the sequence that is due for collection.

Move to the last tag in the sequence that is due for collection.

Write the completed tour run data to the PI Server. You must have write access to the
PI Server and archive permissions for the tour.
Display or hide panes.

Submit the completed tour run for supervisor's approval.

Approve the submitted tour run data and send the approved data to the P ServerI.

Save the tour run.

Close the tour run.

PI Manual Logger User Guide 105

View and Edit Tour Runs

Define Tour Run on the Data Entry Page

The Tour Run Info pane contains the following boxes:

Tour Name
Tour Description
Workstation or Device ID: The PC or Mobile Device identifier. This read-only field is
used to uniquely identify the PC used to collect data with PI Manual Logger, or the
mobile device used to collect data with PI Manual Logger Mobile.
User Name: This read-only box displays the PI Manual Logger or PI Manual Logger
Mobile login name
Tour Run Time Stamp: A valid PI Time. The timestamp format must conform to the
system time format. If you have tour timestamp edit permissions, click to edit the
time.
Tour Comment: Enter a comment, or click to open the Comment/Log Entry dialog
box.
In the Comment/Log Entry dialog box, click >> to show a list of templates you can use for
tour comment entries.

To open the PI Reason Tree Picker, click .

106
 Enter Values for Tags in a Tour Run

Enter and Edit Tag Events

Use the Data Entry Form tab to enter and edit tag events, where an event is defined as the
combination of assigning a value, comment, and a timestamp for a tag.

Note: To do these tasks, users must belong to the Data Entry group. See section
Associate a Tour with a User Group (page 185) for details about specifying user
groups. You must have Send to PI permission level (specified in section General
Tour Options (page 61)) to write values to the PI Server.

The Data Entry Form boxes are:

Tag Name
Tag Value: A valid tag value. This may be keyed in or scanned in (when data is available
in a barcode format on a handheld device).
If digital states (page 93) are configured for the tour, you can select a state for the tag or
tag group from the drop-down list.

Note: User-defined states appear first, followed by SYSTEM digital states.

Enter the tag value in the Tag Value field. To add additional values for a tag, click
and enter a new value. You can add a comment to associate with this new value as well.
The time stamp defaults to Now when you click . All previous values added for the
tag in this tour run appear in the Added Values tab of the Tag Info pane.

To display a trend for the tag, click . The PI Manual Logger Trending dialog box
displays the live trend of the tag. You can scroll the trend through different time ranges.
See section Display Trends (page 96).

PI Manual Logger User Guide 107

View and Edit Tour Runs

If a signature was entered on a handheld device, click to view signatures for the
tag.

If you specified a trigger action to require signature on device and the data has been
signed on a mobile device, then after the tour run data has been transferred back to the
desktop central SQL database, you can see a Signature icon show up next to the tag value
to indicate that the tag value has been signed. You can either move your mouse over the
icon to see the signature, or click icon to see it.

108
 Enter Values for Tags in a Tour Run

Value Comment: A comment associated with the tag. If you are using templates, you
can pick preconfigured comments from the template and add them to the comment text
entry. You can add multiple comments from the template.
Tag Timestamp: A valid absolute PI time. Click the clock icon to insert the current time.
Use of an asterisk (*) is not supported.
If no value is entered, the tour time is used. The value is populated only when Send to PI
is attempted (when the user either clicks Send to PI or closes the window).
Operator Instructions: Shows the operator instructions assigned for the tag.

PI Manual Logger User Guide 109

View and Edit Tour Runs

View History of Previous Values

In the Tag Info pane, the Previous Values tab shows the history of previous values. Several
options are available from the right-click menu.
To use a previous value, comment, or both as the input for a tag, right-click the tag and
select the appropriate option.
To show a trend for a tag, right-click the tag and select Show Trend.
To show the details for a tag, right-click the tag and select Show Details on this value.
The Tag Value Details dialog box (shown in the following figure) shows any additional
annotations (comments) defined for the selected tag value. It also shows any value
attributes that may be set, such as Annotated, Questionable, or Substituted. For example,
the audit record annotation has the following fields for retrieval:
Annotation Name: PIML User Audit
Annotation Description: PIML user who entered the data
Annotation Type: String
Annotation Value: PIML user account who entered the data in PIML
Annotation Creation Date: The timestamp when the value was sent to the PI Server

110
 Enter Values for Tags in a Tour Run

Note: Right-click the annotation list to toggle the view between show details or hide
details of the annotation value. Use the pop-up menu to copy any text
annotations to your clipboard.

To add a comment to a tag value, right-click the tag value and select Add comment.
Enter your comment in the Comment/Log Entry dialog box that appears. The additional
comment is stored as a new annotation.
To view the cached values for the current tag, right-click and select Show Cached Data.

PI Manual Logger User Guide 111

View and Edit Tour Runs

To delete a value from the PI server, select the value you want to delete, right-click, and
choose Delete Selected Value from PI.

Note: If you do not have permissions to delete the selected values from the PI
Server, this menu item is unavailable. If multiple values have the same
timestamp, only the first tag value is deleted.

To change the search range of the displayed historical values for the current tag, right-
click and choose Search Criteria. The Search Previous Values dialog box appears.

If you select the Time-based search option, the Start Time and End Time refer to the
time range for which values from the archive are displayed. For the default values (start:
*-1d, end: *), the most recently archived tag values in the past 24 hours appear.
If the Server Time check box is selected, the time is related to the server. If this check
box is not selected, the time is related to the local computer's time.
If you select the Number of Values option, enter the number of values to search. The
default is 25. The number of values retrieved from the PI Server archive is always equal
to or less than this limit, even though there may be more values in the specified Start and
End time range.
By default, values from the PI Server are displayed in reverse chronological order, with
the most recent appearing at the top. To change the display order, click the appropriate
column header.

112
 Enter Values for Tags in a Tour Run

View History of Added Values

After you have entered a tag value in the Tag Value field, you can add additional values for
the tag. This can be useful, when, for example, you need to correct a spurious value, but want
to keep that value for the record. This maintains the integrity of the previously collected
values in the tour run.

To add a value, click and enter a new value. The previously entered value appears in the
Added Values tab of the Tag Info pane and the Tag Value box is cleared, ready for a new
value. You can add a comment to associate with this new value as well. The time stamp
defaults to Now when you click .
All values added for this tag appear in the Added Values tab of the Tag Info pane. These
options are available from the right-click menu:
To add or edit a comment, right-click and select Add/Modify Comment.
To remove an added value, right-click and select Delete Added Value.

PI Manual Logger User Guide 113

View and Edit Tour Runs

Save Data, Submit Changes, and Set Tag Status

In the Data Entry Sheet tab, right-click the data rows and choose from these options:
Refresh or revert changes.
If the digital states are configured in the tour, set the tag status.
Add additional values for a tag in the same tour run. All values added for the tag appear
in the Added Values tab of the Tag Info pane.
Send current collected values for this tour run to the PI Server.
Save or print the tag data.

While editing an individual field, you can press Ctrl+Z or right-click and select the Undo
option to revert to the previous value in the field. You can also enter or edit the value,
comment, and timestamp by clicking an individual cell.
While viewing the Data Entry Sheet page, you can also view a trend of the tag you are
currently working on, as shown on the Previous Values tab in Tag Info pane.

114
 Enter Values for Tags in a Tour Run

Tag Group Tab

The Tag Group tab is only available if you have a tag group selected. Use it to set the status
for the tag group for the tour run and enter a comment for the tag group for the tour run.

View Symbols Associated With Tags

The Tag List pane is shown in the following figure:

The symbols associated with tags and tag groups are described in the following table:
Symbol Description
The tag or tag group is not due for data collection.
The tag or tag group is due for data collection and has no data.
The tag has valid data entered or the tag group is collected. Tags that were due for
collection have valid data entered.
The tag or tag group has data that violates its limit specifications.

To set the tag or tag group status from the Tag List pane, right-click a tag or tag group, select
Set Status, and select a status from the drop-down list.

PI Manual Logger User Guide 115

View and Edit Tour Runs

Import Tour Run Data

To import tour run data from external files:

1. In the Select a Tour Run dialog box, click .

2. In the dialog box that appears, enter the import file's path and filename, or click to
browse for the file.
The external files can be either an XML file in the defined XML format or a SQL Server
Compact Edition database file (.SDF).
The PIPC\PimlWindows\Samples folder includes a sample of the XML dataset called
Sample PIML Tour Run Dataset.xml.
For importing from the SQL Server Compact Edition file (.SDF), the files can be from
Windows Mobile devices and Tablet PCs running PI Manual Logger Mobile.

Note: PI Manual Logger cannot import the sample file unless you create the PI points
used in the sample first.

Review a Tour Run

Users who belong to a tour's administrative group can review and modify any submitted and
un-archived tour run data before sending it to the PI Server.
To review tour run data:
1. Select Tours > Tour Run List (Manual Data Entry and Review).
2. Select the completed tour runs to review.

3. Click .
The Data Entry dialog box appears. You can review and modify the data when appropriate,
and then approve and send all the data to the PI Server.

Note: After you send reviewed data to the PI Server, the data is still stored in the SQL
Server database.
OSIsoft recommends that you use PI client tools to retrieve tag values, comments,
and other auditing information from the PI Server.

116
 View the History of a Tour Run

View the History of a Tour Run

You can view the history of a tour run to see its past saved events.
To view the history of a tour run:
1. Select Tours > Tour Run List.
2. Select the tour and tour run.

3. Click .
The Tour Run History dialog box shows who edited the tour runs, when edits were made,
what the status of the tour was when the edit was completed, and the workstation (or device
ID) when the edit was completed.

PI Manual Logger User Guide 117

View and Edit Tour Runs

View Changes Made to the Tour Run

The Audit Log page shows any changes that have been made to the manual data since the
creation of the tour run.

Note: If you delete a tour run, you also delete its audit log from the PI Manual Logger
database.

118
 View Unapproved Tour Run Data

View Unapproved Tour Run Data

To manage unapproved tour run data stored in the database, select Tours > Tour Run
Maintenance.
In the Tour Run Maintenance dialog box, you can view the list of unapproved tour run data
and their statuses. You can also remove any of the unapproved tour run data. We recommend
that you periodically remove old tour runs that have been archived.

Note: Only users that are members of the pimladmin administrative group can access
this function.

Note: Approved tour run data is saved in the target PI tags. We recommend that you use
corresponding PI client tools (such as PI ProcessBook and PI DataLink) to view
the approved data available.

PI Manual Logger User Guide 119

View and Edit Tour Runs

View and Edit the Message Log

You can access the message log in the Data Entry dialog box to display the log entries. To
open the Message Logs pane, click and select Message Log.

Right-click in the Message Logs pane to refresh the display, add a new log entry with the
Comment/Log Entry dialog box, or copy the entire log onto Windows clipboard so you can
paste the text into another application.

120
Chapter 6

Use PI Manual Logger Mobile

You can download a tour to a mobile device, and use PI Manual Logger Mobile to collect
data. A tour run is a set of values, statuses, comments, and associated time stamps taken for
tags in a tour as they are entered on a mobile device. After it is completed, the tour run is then
uploaded to the PI Manual Logger PC client, where you can review and edit the data before
sending it to the PI Server. Alternatively, you can configure PI Manual Logger to
automatically send the collected data to the PI Server after the tour runs are transferred to the
PC client.
If the device has a network connection to the server hosting the PI Manual Logger Web
Services, you can initiate wireless data transfer from the device.

PI Manual Logger User Guide 121

Use PI Manual Logger Mobile

Installation Flow Chart

This flow chart can help you with the installation of PI Manual Logger Mobile.

122
 Before You Start

Before You Start

Verify that your systems meet the requirements listed in this section before installing PIML
Mobile.

Mobile Device Prerequisites

Supported Operating Systems:
Windows Mobile 2003 for Pocket PC
Windows Mobile 2003 Second Edition for Pocket PC
Windows Mobile 5.0
Windows Mobile 6.0 Classic or Professional
Windows Mobile 6.1 Classic or Professional.
Windows XP or Vista Mobile PC
Supported Mobile Device Communications Software:
The appropriate version of ActiveSync for your target Windows PC operating system
(XP/2003) and Windows Mobile device operating system
The appropriate version of Windows Mobile Device Center (WMDC) for Windows
Vista, Windows 7, Windows Server 2008, and your Windows Mobile device operating
system
Minimum Hardware Requirements:
Resolution of VGA (480 x 640) or QVGA (240 x 320)
64 MB RAM

Note: The number and size of tours is based on the available RAM on the device.

USB, Serial, Infrared, or Bluetooth connection to a PC

Optional:
Flash memory card. For example, CompactFlash (CF) or Secure Digital (SD)
Scanning device. For example, Barcode scanner, RFID reader, or MagStripe reader
Wireless connection

Note: As long as a mobile device is loaded with the appropriate operating systems
(Windows Mobile 6 classic or professional, etc.), the CPU type is not an issue.

PI Manual Logger User Guide 123

Use PI Manual Logger Mobile

Supported Scanning Devices

Scanning devices such as Barcode, RFID, and Magnetic Stripe Reader, on select
handheld devices which provide software that directs scanned data to Manual Logger as
input text (e.g. Symbol DataWedge and Intermec SmartWedge). Please contact your
device manufacturer to obtain this software.
Integrated barcode scanning. This feature allows the data collector to capture a barcode
scanned event while viewing the Data Entry screen in PI Manual Logger Mobile, where
the barcode is associated with a tag or tag group. The tour option Use barcode scanning
for navigation instead of data entry on data entry screen must be enabled in order to
use this feature. See section Barcode Tour Options (page 64). PI Manual Logger supports
integrated barcode scanning for these Symbol devices:
MC50
MC70
MC75
MC9000
MC9090
PDT8100
PDT8100X
PPT2800
PPT8000
PPT8800

System/PC Client/Server Prerequisites

The prerequisites for the system, PC Client, and server are the same as those described in
Chapter 2 Installation (page 11).

124
 Before You Start

Pre-Installation Considerations
If you plan to use Windows Mobile devices to manually collect data with PI Manual Logger
Mobile, install the mobile device communication application (ActiveSync or WMDC) that is
appropriate for your system. This must be installed and running on the PC before you can use
a mobile device to collect data.
If you have a previous version of PI Manual Logger Mobile installed on your mobile device,
transfer all remaining data to the desktop then remove the previous version, using ActiveSync
or WMDC.
Windows 2003/XP
This version of PI Manual Logger requires the appropriate version of ActiveSync for your
target operating system and Windows Mobile device operating system. To obtain the latest
version of ActiveSync, see the Microsoft Web site.
Windows Vista/Windows 7/Windows Server 2008
This version of PI Manual Logger requires the appropriate version of Windows Mobile
Device Center for Windows Vista, Windows 7, Windows Server 2008, and your Windows
Mobile device operating system. To obtain the latest version of Windows Mobile Device
Center, see the Microsoft Web site.
Non-Volatile Memory Cards
Non-volatile memory cards vary in performance, reliability, upgradeability, and so forth.
Therefore, carefully evaluate the different options and trade-offs to determine the feasibility
of using a non-volatile memory card when installing PI Manual Logger Mobile components
(.NET Compact Framework, SQL Server Compact Edition, and PI Manual Logger Mobile).
Refer to these web sites for more information:
Microsoft MSDN (http://msdn.microsoft.com/en-us/library/ms838028.aspx)

Microsoft Forums
(http://forums.microsoft.com/MSDN/ShowPost.aspx?PostID=3014412&SiteID=1)

Note: If you install PI Manual Logger Mobile, .NET Compact Framework, or SQL Server
Compact Edition in a non-volatile memory location, you must completely reinstall
the .NET Compact Framework and SQL Server Compact Edition runtime in case
of battery loss (except on Windows Mobile 6.0). This is because some required
runtime files are always installed in the \Windows RAM folder, regardless of which
location you choose during installation.

PI Manual Logger User Guide 125

Use PI Manual Logger Mobile

Mobile Device Application Installation

Open ActiveSync or WMDC and either work as a guest or set up a partnership between the
mobile device and the PC running PI Manual Logger.
To install the device applications:
1. Make sure the mobile device is powered up and cradled to allow the set-up kit to copy
files to the device. If this is not possible, the set-up kit will resume and copy these files as
soon as you power up the device and cradle it.
2. Start the PI Manual Logger Mobile set-up kit.
3. Follow the instructions in the dialog boxes. See section Install Windows Mobile 2003,
Windows Mobile 5 (page 126) or Install Windows Mobile 6 (page 130).

Install Windows Mobile 2003, Windows Mobile 5

After you start the PI Manual Logger Mobile set-up kit, the dialog box shown in the
following figure appears. If you are using a non-volatile memory card, be sure you
understand the information about these cards, as described in section Pre-Installation
Considerations.

Note: You may receive this message during installation:

The program you have installed may not display properly because it was
designed for a previous version of Windows Mobile software. You can ignore
this message and complete the installation.

Note: During installation you may receive a message indicating that the publisher
cannot be verified. You can ignore this message, click OK, and complete the
installation.

126
 Mobile Device Application Installation

1. Choose the device type: Windows Mobile 2003 or Windows Mobile 5.0 and click Next.
Click Next again to start the installation.
The Microsoft .NET Compact Framework 2.0 and Microsoft SQL Server Compact
Edition 3.1 installers start after you choose where to install device CAB files.

Installation messages for Windows Mobile 2003 appear on the PC desktop, as shown in
the following figure.

Installation messages for a Windows Mobile 5.0 device appear on the device itself.

Note: Be sure to monitor these messages carefully and respond accordingly.

During installation for Windows Mobile 5, if you receive a request to restart the
device (as shown in the following figure), click Cancel on the device and do
not restart it.

PI Manual Logger User Guide 127

Use PI Manual Logger Mobile

2. For Windows Mobile 5.0, when the SQL Server installation is finished, click OK (shown
in the following figure) before you click OK in the installation message on the PC.
Otherwise PI Manual Logger Mobile may not be installed on the device even though
installation appears to proceed normally.

3. The PI Manual Logger Mobile installer appears. You can install the application in the
default location (\Program Files\pipc\PimlMobile on the device) or on a non-
volatile memory card.

128
 Mobile Device Application Installation

Note: Even if you install PI Manual Logger Mobile in a non-volatile memory location, you
must completely reinstall the .NET Compact Framework and SQL Server Compact
Edition runtime in case of battery loss (except on Windows Mobile 6.0). This is
because some required runtime files are always installed in the \Windows RAM
folder, regardless of which location you choose during installation.

PI Manual Logger User Guide 129

Use PI Manual Logger Mobile

Install Windows Mobile 6

After you start the PI Manual Logger Mobile set-up kit, the dialog box shown in the
following figure appears. If you are using a non-volatile memory card, be sure you
understand the information about these cards, as described in section Pre-Installation
Considerations.

Note: During installation you may receive a message indicating that the publisher
cannot be verified. You can ignore this message, click OK, and complete the
installation.

1. Choose the device type: Windows Mobile 6.0 and click Next. Click Next again to start
the installation.

130
 Mobile Device Application Installation

2. When the message appears prompting you to check the device to see if additional steps
are needed, look for a display similar to the following:

3. After you choose where to install PI Manual Logger Mobile, in the default tlocation
(\Program Files\pipc\PimlMobile on the device) or on a non-volatile memory
card, tap Install on the device. Be sure to make your selection and tap Install before
before you click OK in the installation message on the PC. Otherwise PI Manual Logger
Mobile may not be installed on the device even though installation appears to proceed
normally.

4. After installation is finished, look for a display on the device similar to the following
figure:

PI Manual Logger User Guide 131

Use PI Manual Logger Mobile

5. Tap OK on the device, and then click Finish in the installation dialog box on the PC
desktop.

132
 Post-Installation Procedures

Post-Installation Procedures
This section describes procedures you need to follow after installation is complete.

Set Up and Configure Connections

Set up the connection management software as appropriate for your application. You can
choose the Guest Only mode or set up a partnership. Use a partnership if you want to
synchronize information, unrelated to PIML, between the device and the computer, such as
calendar, inbox, contacts, files, and so forth. Note that Partnership synchronization is more
time consuming. Also, if a partnership is set up, then you must indicate this in PIML’s
AutoSync, if you are using this application.

SQL Server Compact Edition for Windows XP/Vista Mobile PC Users

The SQL Server Compact Edition files installed in the \PIPC\PimlMobile folder are
intended for mobile devices. If you have selected the Windows XP/Vista Mobile PC option
on the Mobile Device Type Selection dialog box during the PI Manual Logger Mobile setup,
copy the SQL Server Compact Edition files for Mobile PC from the
\PIPC\PimlMobile\SQLMobilePC folder into the \PIPC\PimlMobile folder.

Install on Multiple Devices

If you want to install PIML Mobile on multiple mobile devices, installation depends on the
type of device.
For Windows XP/Vista Mobile PCs, run the Manual Logger Mobile setup kit on each
Mobile PC, following the steps in section Mobile Device Application Installation (page
126) of the PI Manual Logger User Guide.
For Windows Mobile 2003/5.0/6.0, use the PIML Device Installer application, which is
included on your PC. The PIML Device Installer application can also install or reinstall
SQL Server Compact Edition and .NET Compact Framework. Use the device installer to
install the device applications to multiple devices with the same or different operating
systems.

Note: As long as a mobile device is loaded with the appropriate operating systems
(Windows Mobile 6 classic or professional, etc.), the CPU type is not an issue.

PI Manual Logger User Guide 133

Use PI Manual Logger Mobile

To launch the PI Manual Logger Device Installer, choose Start > All Programs > PI System
> PI Manual Logger > PIML Device Installer. The PIML Device Installer dialog box
appears.

You can install or reinstall the following components on a connected mobile device:
Microsoft .NET Compact Framework
Microsoft SQL Server Compact Edition
PI Manual Logger Mobile

Note: In Microsoft Windows Mobile 6, SQL Server 2005 Compact Edition and the
Microsoft .NET Compact Framework 2.0 are installed into the ROM of the devices,
so there is no need to install these two components if you have a Microsoft
Windows Mobile 6 device.

After you begin the installation of one of the components, Microsoft's Application Manager
will be launched. From there, you can follow the on-screen instructions to complete the
installation of the component on your mobile device.

134
 Post-Installation Procedures

Initialize the Mobile Database

Before collecting data with a mobile device, you must create and initialize the device
database using the Device Initialization feature.

Notes: If you abort the initialization process before it is completed, the database is
unusable for PI Manual Logger Mobile.

If you are using a memory card that has a write-protection switch, such as an SD
card, disable the write-protection before using it with PI Manual Logger Mobile.

To initialize the database:

Start PI Manual Logger on the Client PC. If the Getting Started dialog box appears,
click Manage Mobile Devices and Transfer Data, and then select Device Initialization
in the Mobile Device Tasks dialog box.
If the Getting Started dialog box does not appear, click Mobile Devices > Initialize
Device Database. In the Device Initialization dialog box that appears, click Start.

Configure Mobile Device Settings

Before collecting data with a mobile device, you can configure the device with your own
personal settings. This is an optional step since the default settings are acceptable. Verify that
the device is cradled and connected through ActiveSync/WMDC. Then, on the PI Manual
Logger client, select Mobile Devices > Mobile Device Settings. The Mobile Device
Settings dialog box appears.

PI Manual Logger User Guide 135

Use PI Manual Logger Mobile

The device settings on the General tab are:

Main Database Path: The device path to the SQL Server 2005 Mobile database. The file
extension must be .sdf.
Temporary Folder to hold data transferring: A device folder where temporary data is
held during data transfer.
Web Service Server Address: The URL to the installed PI Manual Logger Web
Services server Web page. This URL is used during Web services data transfers that are
initialized by the device and is used only for transferring data wirelessly.
Device ID: The connected device's ID. This user configurable string is logged for all tour
run data the device collects.

Note: Use only alpha-numeric letters and spaces to name the Device ID.

On the Device Modes tab of the Mobile Device Settings dialog box, specify whether the
device runs in Single User mode and/or Single Tour mode.

The device setting on the Device Modes tab are:

Single User Mode: If clicked, when PI Manual Logger Mobile is started on the device,
there is no login prompt and the specified user is always logged in. This is useful in
situations where the device belongs to one user or user authentication on the device is not
required.
Single Tour Mode: If clicked, it allows you to have only one tour on the device. When
you start the device application, the Data Entry screen for the tour appears without
displaying the Tour List screen first. This is useful in situations where the device is task-
specific and only one tour is needed at one time on the device.

136
 Post-Installation Procedures

Enable SmartMinimize Icon on device: If clicked, PI Manual Logger enables the

Windows Mobile SmartMinimize icon in the upper right corner of PI Manual Logger
Mobile. This provides an alternative way to close the application.
Enable Web Services data transfer on device: If clicked, the icons and menus for web
services are enabled on the device. Disabling this will prevent a mobile device from using
the optional PI Manual Logger Web services for data transfer.
For example, when Web service icons and menus have been disabled, you will not be
able to select Update Data from Host, Send Data to Host, or Send Log to Server from
the File menu and Sync Date/Time from the Tools menu.

After you specify the device settings, click OK to save the changes on the device.

PI Manual Logger User Guide 137

Use PI Manual Logger Mobile

Perform Mobile Tasks from a PC

You can perform mobile device tasks from the PC client. To access the Mobile Device Tasks
dialog box, choose Mobile Devices > Common Tasks.

Note: The device must be connected through ActiveSync/WMDC before you can
perform these mobile device tasks from your PC.

Get Device Information

After you have established a successful ActiveSync/WMDC connection to a Windows

Mobile-based device, you can check the device information through the Device Information
menu. To do this, in the PI Manual Logger client, choose Mobile Devices > Device
Information.
The Mobile Device Information dialog box shows the device's OS version, memory
information, battery status, and device screen resolution. To obtain device information, along
with a list of running processes, click Help>About.

138
 Transfer Data from the PC to a Mobile Device

Transfer Data from the PC to a Mobile Device

Use the Device Data Transfer Console to transfer data between the host database and
mobile databases. To open this dialog box, on the PC Client, choose Mobile Devices >
Device Data Transfer.
The PC Tour List pane on the left side of the dialog box lists the tours and tour runs in the
current PI Manual Logger database. The Device Tour List pane on the right side of the
dialog box lists tours and tour runs on the currently connected mobile device. Each list has its
own toolbar.

When transferring data from PI Manual Logger Mobile running on Windows XP/Vista (such
as a tablet PC or data entry desktop), you must wait for PI Manual Logger PC to check for a
cradled handheld device. If it does not find a handheld device, you must specify an alternative
location, which allows you to customize the behavior of PI Manual Logger PC when it
attempts to synchronize. A dialog box will prompt you to either (1) check for connected
Windows Mobile device, (2) check for a database file at <file location>, or (3) prompt for the
location. You can also open this dialog box by clicking Mobile Devices > Mobile Database
Location Setup.

PI Manual Logger User Guide 139

Use PI Manual Logger Mobile

Note: Wait until ActiveSync or Windows Mobile Device Center has recognized that the
device is connected and cradled prior to opening the Device Data Transfer
Console screen, because there can be a slight delay that causes PI Manual
Logger to prompt you for a location if Load from mobile device is first in the list.

PI Manual Logger creates a temporary, transfer folder called PimlMobileData under the
My Documents folder. You cannot change the location of this transfer folder.
The PC Tour List tools are:

Refresh: Refresh the list.

Logs: View the current data transfer logs from the current transfer session.

Note: When you close this dialog box, the transfer logs are not saved. Any auditing
information, however, such as send to PI events, exceptions, and tour changes,
are logged by the tour run audit trail or the message log system and saved in the
PI Manual Logger database.

Filter by: Enter the string by which you want to filter the tour list.
Apply: Apply the filter to the list.
View: View all tours or only tours available to you (if you are not a PI Manual Logger
administrator).

140
 Transfer Data from the PC to a Mobile Device

The Device Tour List tools are:

Refresh: Refresh the device list.

Transfer: Start data transfer.
Info: View the device's information.
Settings: Display the Mobile Device Settings dialog box, see Configure Mobile Device
Settings (page 135).
Database: Choose which local database file you are using for data transfer.

Download Tour Definitions

To download tour data to your mobile device and to upload tour run data from the device to
the PC:
1. Choose Mobile Devices > Device Data Transfer.
2. Select the tour(s) you want to transfer.

3. Click . The tours to be transferred appear in the Device Tour List panel.

4. Click to select the available transfer options from the Device Data Transfer
Options dialog box.
On the Receive Options tab, you can choose from these options:
Whether to import all tour runs.
Whether to import only completed tour runs into the central PI Manual Logger
database. Tour runs that are still in progress remain on the device.

PI Manual Logger User Guide 141

Use PI Manual Logger Mobile

On the Send Options tab, choose from these options:

Whether to reload the PIML user database on the device. This database contains the
PIML group and user permissions.
Whether to update PI tag values before transferring.
Specify the number of tour runs per tour to retain on the device after the transfer.
This allows you to re-open the tour run and review or edit tag data. For reasons of
memory limitations on the device, OSIsoft recommends that if you choose to retain
tour runs on the device, retain only one. Note that if this value is less than the number
of incomplete tour runs, all incomplete tour runs remain on the device.

When Update cached PI tag values before transferring is selected, the data transfer
updates the latest PI tag archive values from PI before sending them to a mobile device.
5. Click OK to save changes to the device data transfer options. Otherwise, click Cancel.
6. Click to initiate the transfer.

Note: Tour runs remain on the device under these conditions:

- Only completed tour runs are transferred because the Import only completed
tour runs" is selected on the Receive Options tab, and tour runs are in the in-
progress state.

- Tour run(s) are to be retained on the device based on the number of tour runs
per tour to retain specified on the Send Options tab is greater than zero.

You can start PI Manual Logger Mobile and start collecting data after the tours are
successfully transferred to the device.
Delete Tour Definitions from the Mobile Device
The only way to remove tour definitions from the device is to reinitialize the device database.
After reinitializing the database, you can then transfer new tour definitions to the device.
Note that Unselect button on the Device Data Transfer Console center toolbar only removes
tours from the transfer list if they have never been transferred.

142
 Transfer Data from the PC to a Mobile Device

Use Mobile Data Transfer Wizard

As an alternative to selecting and transferring data manually, use the mobile data transfer
wizard. To use the wizard:
1. Click Mobile Devices > Mobile Data Transfer Wizard.
2. Click Next. Click the type of data transfer you want to start.
3. Optionally, update your mobile device settings. Click Next.
4. If you are using the device for the first time with PI Manual Logger Mobile, create your
device database. Click Next.
5. Click Finish. Now you can specify tours you want to transfer and other transfer options.

PI Manual Logger User Guide 143

Use PI Manual Logger Mobile

Start PI Manual Logger Mobile

Before using a mobile device for data collection, you must first download configuration
information to the mobile device.
Before starting PI Manual Logger Mobile, hide the soft keyboard or any other data entry
methods so you get the full screen height for displaying the forms. After the application is
running you can use the soft keyboard or any of the other data entry methods to enter data.
To start the mobile application, choose Start > Programs > PimlMobile.
The login information is the same as your PI Manual Logger user account and password you
use on the desktop. The default user name and password is piml.

Note: As with the desktop application, the username is case insensitive and the
password is case sensitive.

After you log in successfully, the Tour List screen appears.

If you have configured for single-user mode (page 135) for devices, you are not asked to log
in. Instead, the screen indicates you are in single-user mode.

144
 Start PI Manual Logger Mobile

If you start PI Manual Logger Mobile before the database is initiated, a welcome screen
appears on the device. The welcome screen displays instructions on how to initialize the
mobile device for its first use.

PI Manual Logger User Guide 145

Use PI Manual Logger Mobile

Main Menus

File Menu

The PI Manual Logger Mobile File menu items are:

Start a new run: Start a new tour run. You can also tap . Be sure to select a tour from
the tour list first.
The user ID defaults to the login name, and the tour's timestamp defaults to the nearest
hour.
Edit/Resume run: Edit previously collected data, or resume your current tour run. You
can also access this function in the tour list: With the cursor on a child node, tap to
edit previously collected data. Be sure to select a tour from the tour list first.
Update Data from Host: Receive tours and update cached information wirelessly using
PI Manual Logger Web Services.
Send Data to Host: Send collected data wirelessly using the PI Manual Logger Web
Services and (optionally) send data to the PI Server.
Message Log: Show the local message log (page 165) saved on the mobile device. You
can also create manual entries here.
Send Log to Server: Send the message log stored on the device wirelessly using the PI
Manual Logger Web Services, and clear the log on the local device. You can create
manual entries here as well.
Switch User: Log on as a different user or log off the current user session and keep PI
Manual Logger running. You must log on again to able to enter/transfer data if you have
logged off. This feature is not available in Single-User mode.
Exit: Log off and exit PI Manual Logger Mobile.

146
 Main Menus

Tools Menu

The PI Manual Logger Mobile Tools menu items are:

System Clock: Link to the system clock setting on the device. Use this feature to
manually adjust the device system clock. You must belong to the PIMLADMINS group
to modify the system clock.
Sync Date/Time: Synchronize the device time and date with the PI Manual Logger Web
Service host. This is useful for restoring the device time after the device power has been
drained.
Device Initialization: Clean up the mobile database by erasing all tour run data. Tour
list(s) and historical data will not be deleted. You must belong to the PIMLADMINS
group to reinitialize the device.

Caution: You cannot recover collected data after deleting it. Verify the collected
data is no longer needed prior to deleting it.

Global Settings: Change the mobile database path, temporary data storage path, device
ID, and PI Manual Logger Web Service URL. Only users in the PIMLADMINS group
can make changes to the global settings.

PI Manual Logger User Guide 147

Use PI Manual Logger Mobile

User Options: Change the tag display and font size. These options are saved individually
for each user.

Device Status: Show the device's memory, battery, and network connection status. When
a wired or wireless network connection is present, the device displays the correct network
IP address followed by the text Connected.

View Menu

In the Data Entry screen, the View menu items are:

All tours or My tours: Display only your tours or all tours.
Sort: Sort the tour list by tour name, if more than one tour is available on the device.

148
 Main Menus

Help Menu

The PI Manual Logger Mobile Help menu items are:

About: Shows the summary of system information regarding the device and a list of
running processes. The displayed system information can be used for troubleshooting and
diagnosing potential problems.
Contents: Opens the PI Manual Logger Mobile help.

Note: The device help includes only basic help information. For complete information
on PI Manual Logger, see the PI Manual Logger User Guide.

PI Manual Logger User Guide 149

Use PI Manual Logger Mobile

Data Entry Methods

PI Manual Logger Mobile supports the following Windows Mobile device input methods:
Soft Keyboard
Character, Letter, or Block Recognizer
Microsoft Transcriber
Hardware Keyboard (attached or built-in)
In addition, several third-party soft keyboards—large keys and numbers-only keyboards—
and other data entry methods, such as barcode scanners, work well with PI Manual Logger
Mobile.

Scan Barcodes with Mobile Devices

Barcodes can be used as aliases for individual tags or tag groups for the data collection
points. During manual data collection, when you can scan a barcode, PI Manual Logger
Mobile jumps to the data entry screen for the tag or group associated with the barcode.

Note: Barcode scanning hardware varies. See your device's user manual or consult with
your hardware vendor to learn how to trigger your barcode scanner.

Barcodes are mapped to tag names and groups in the Tour Definition dialog box. You can
configure PI Manual Logger to prompt the operator either to scan or to enter a barcode before
the data entry screen appears.
Barcodes used in PI Manual Logger can be as many characters as the barcode standard and
barcode scanning hardware support. Some common barcode formats used in mobile device
environment are:
Code Length Decode options, comments
UPC-A 12 Transmit check digit enabled
UPC-E0 6
EAN-8 8
Code 39 Variable Verify check digit disabled
Codabar Variable
Code 128 Variable

Note: If the Barcode must be scanned before data entry is allowed option is selected
in the Barcodes Tour Options dialog box in the PI Manual Logger PC
application, users must enter a barcode associated with a tag or tag group before
they can enter data for it.

150
 View Tours

View Tours
The main screen in PI Manual Logger mobile is the Tour List screen.
The Tour List screen is organized in a tree view. The top nodes in the tree view are tours and
the sub-nodes are tour runs.
A tour node shows the tour name. A tour run node shows the tour run timestamp and the ID
of the user who created the tour run.

Main Toolbar

The PI Manual Logger Mobile main toolbar items are:

Tool Description
Initiate a bidirectional wireless data transfer between the server and the device. Any
collected manual data is sent to the host PIML web server. The updated tour definition
and cached tag attributes are downloaded onto the device.
View, modify, and add log entries.

Show global settings for the mobile device.

Clean up the mobile database by erasing all tour run data on the device.
View or change the current user account by opening the login screen. The current user
cannot be changed if 'Single User Mode' is displayed indicating the Single User Mode
device option is set which automatically logs in the user.

PI Manual Logger User Guide 151

Use PI Manual Logger Mobile

Tour and Tour Run Toolbar

When a tour is selected, you see:

When a tour run is selected, you see:

The Tour and Tour Run tools are:

Tool Description

Create a new tour run for the selected tour.

Open the selected existing tour run data.

Delete the selected tour run data. You must have Full Access permission to use this tool.

152
 Enter Data

Enter Data

To run a tour, select a tour from the tour list and tap . Some tour scheduling options
provide a drop-down list for the Tour Timestamp of selectable timestamps of tours that have
not yet been created.
Tap the OK button to start the new tour run. Note that the operator can disable all conditional
checking (Clock Scheduling and CMDE) on the device in order to collect tour run data
without the automatic display of only tags that are due and without prompts for collection of
empty tags that are still due for collection based upon Clock Scheduling or CMDE. To do
this, the operator taps the Turn all scheduling off check box before clicking OK.

The Data Entry screen shows the tag name and descriptor, tag value, and timestamp.
Depending on the Timestamp Tour Options settings, the default tag timestamp is set to
either the tour's timestamp or the current timestamp, which is read from the mobile device
clock.
To enter tour data:
1. Enter a tag status value in the Value box, or click a preconfigured digital tag status from
the drop-down list. If a barcode represents the tag's value and not the identification of a
tag, then a value can be scanned into a tag value by placing the cursor on the tag value
field on the data entry form and scanning in the barcode.
2. Tap or the keyboard Enter key to process the entry and go to the next due tag. The
navigation toolbar can also be used.
Depending on your barcode scan option setting, either a prompt to scan a barcode or the next
tag in the sequence appears.
Depending on your limit check setting, if you enter a value that violates one or more limits
specified for the tag, the Limit Violation Warning dialog box may appear.

PI Manual Logger User Guide 153

Use PI Manual Logger Mobile

Tour Run Toolbar

The Tour Run toolbar functions are:

Tag Tools
Tool Description
Switch to the tag value data entry screen.

View and modify tag comments.

Switch to the tag list screen.

View the tag value history.

Tour Tools
Tool Description

View and modify tour comments.

Edit the tour state.

View and update the manual log.

View the audit log for the current tour run.

154
 Enter Data

Navigation Tools

The navigation tools in the tour run Data Entry screen are:
Tool Description

Go to the first tag in the sequence.

Go to the previous tag in the sequence.

Go to the next tag in the sequence.

Go to the last tag in the sequence.

Note: Depending on how the tour options are configured, the navigation tools, may (1)
display only the tags that are due for collection, or (2) display all tags, whether
they are due or not. In case 1, as you navigate through tags to enter data during a
tour run, only those tags that are due for collection are listed. To navigate to the
next tag that is due, choose Go > Go to Next Empty Tag, or tap . If you need
to see a tag that is not due, tap the Group tab, select the tag, and tap Go.
In Case 2, all tags are displayed, whether they are due or not.

Tag Status Indicators

The tag status indicators in the Data Entry screen are:

Icon Description

Indicates that the tag is not due for data collection.

Indicates that the entry violates a limit, as defined in section Set Data Validation Limits (page
82). Tap this icon to display the details about limit violation.
Indicates that there are operator instructions for this tag. Tap this icon to display the
instructions.
Shows the tag attributes for the current tag.

Shows a trend of archived values.

Indicates that there are comments associated with the current tag.

PI Manual Logger User Guide 155

Use PI Manual Logger Mobile

Tag List View (Group Page)

The tag list view shows all tags and tag groups in a hierarchical tree. To access the tag list
view, tap the Group tab at the bottom of the Data Entry screen.
In the tag list view, you can see the logical organization of tags: tag groups defined for the
current tour. You can also navigate through the tree and jump to data entry for any tag in the
tour, regardless of whether it is due for data collection. The status icons are described in the
following table:
Icon Indicates

There are tags in the group that are due for collection.

No tags are due for collection.

All "due for collection" tags in the group have values entered. Even if tags that are not
due for collection exist in the tour, the group status is still the .
The group contains tags with limit violations.

156
 Enter Data

When you select a tag group in the list, the toolbar for tag groups also appears at the bottom
of the display. The icons for the group are described in the following table:
Icon Indicates

Select the group and tap to set the status of the group.

Select the group and tap to add a comment to the group.

Select the group and tap to refresh the display.

Select a tag within the group and tap to display the data entry screen for the tag.

To set the status of a tag group, select a tag in the group and select Value>Set Group
Status. Then select the SYSTEM digital state to associate with all the tags in that group.
The target name and icon displayed in the Set Status window indicate the current target
for which the status is set. The target can be a tag group or the whole tour .

To add a comment to a tag group, select the tag group and tap . The comment will be
associated with all subgroups and tags within the group.
To view the Data Entry screen for a tag, select the tag and tap .

PI Manual Logger User Guide 157

Use PI Manual Logger Mobile

Data Entry Menus

Tag Menu

In the Data Entry screen, the Tag menu items are:

Validation Limits: Display the limit definitions for the current tag.
Operator Instructions: Display the operator instructions.
Show Trend: Display a simple, static trend.
Tag Attributes: Display the Tag Attributes dialog box.
Discard and Close: Discard any changes made to the current tour run and exit the Data
Entry screen.
Save and Close: Save the current tour run and exit the Data Entry screen.

Note: If there are tags for which no values were entered, a message prompt
appears:

Tap Yes to close the run. Later you can choose File > Edit/Resume Run to
enter more data.

Tap No to continue entering data. Choose Go > Go To Next Empty Tag to

locate empty tags.

158
 Enter Data

Go Menu

In the Data Entry screen, the Go menu items are:

Go To Next: Go to the next tag in the sequence.
Go to Previous: Go to the previous tag in the sequence.
Go to First: Go to the first tag in the sequence.
Go to Last: Go to the last tag in the sequence.

Note: You can use the navigation icons instead of these menu items.

Go To Next Empty Tag: Open the Data Entry screen for the next due tag, that is, one
for which a value is not yet entered.
Scan a Barcode: Open the Scan Barcode dialog box. When you enter or scan a barcode,
the tag corresponding to the barcode appears. To select a tag group, tap the Tag Group
List icon. Press Ctrl+B while on the Value field to also open the Scan Barcode dialog
box.

PI Manual Logger User Guide 159

Use PI Manual Logger Mobile

If the tags are grouped by a tag group and a barcode is assigned to the group, when you
scan a barcode, the Data Entry screen appears with the first due tag in the tag group.

Note: If the tour is configured for mandatory barcode entry (page 64), the Data Entry
screen is locked until a user enters a barcode. In addition, if you are using
supported Symbol barcode scanning devices, the Barcode Entry screen is
read-only, as you must scan a barcode into the Barcode Entry text box. For a
complete list of Symbol devices with integrated mandatory barcode scanning
support, see section Supported Scanning Devices.

Add a comment: Opens the Comments page for the current tag.

160
 Enter Data

Value Menu

In the Data Entry screen, the Value menu items are:

Use Previous Value: Use the most recent historical value as the current tag value.
Use Previous Comment: Use the most recent historical comment as the comment for the
current tag value.
Use Previous Value and Comment: Use the most recent previous value and comment as
the value and comment for the current tag.
Add Another Value: Enter one or more additional values in the same tour run for the
tag. Added values appear in the History tab and are indicated by the tilde character. This
can be useful, when, for example, the operator needs to make an adjustment while in the
field, but wants to maintain all values for the record.
Set Group Status: Select a status to apply to all tags within the tag's parent group and
any subgroups within the parent group. This is useful for handling groups of tags quickly.
Reverse digits: Transpose the digits for the current value. This is useful for meters when
the digits have to be read from right to left. If 1234 is entered and you select this menu
item, the entry becomes 4321.
Restore/Clear Value: Undo any editing changes to the Value box and restore the value
from the last saved state, or if there is no previous value, clear the Value box.
Feet-inch Conversions: Converts data in number.number.number format to feet-inches.
The conversion factor is configured on the Other tab in the Tour Options dialog box.

PI Manual Logger User Guide 161

Use PI Manual Logger Mobile

Time Menu

In the Data Entry screen, the Time menu items are:

Enter Current Time: Use the current time as the timestamp for the current tag. This
option is enabled when the timestamp is editable.
Enter Tour Time: Use the tour timestamp as the timestamp for the current tag. This
option is enabled when the timestamp is editable.
Edit Tag Timestamp: Make the tag timestamp box editable so you can enter a new time
in it. Click this menu option again to toggle between an editable and read-only
timestamp.
Edit Tour Timestamp: Open a dialog box to edit the current tour's timestamp. If the tags
are configured to default to the tour timestamp (page 63), then the timestamps for all the
tags reset to the new tour timestamp.
Restore/Clear Tag Timestamp: Open a dialog box to undo all timestamp-related editing
changes for the current tag, and restore the timestamp from the last saved state or clear
the timestamp box. This option is enabled when the timestamp is editable.

View Menu

In the Data Entry screen, the View menu items are:

Read Only: Makes the current data entry session read-only. Use this function to review
entries and prevent accidental overwriting or editing. Choose this menu option again to
toggle between Read-Only mode and Edit mode.
Options: Open the Tag Display Options dialog box, which allows you to change the tag
and font display preferences. These options are user-based—each PI Manual Logger user
can adjust these settings individually.

Note: Any changes you make take effect when you navigate to a different tag.

Device Status: Show the current device memory usage, battery power, and network
connectivity status.

162
 View Tag History

View Tag History

In the Tag History page, you can view a tag's historical values and comments. To access this
page, tap the History tab at the bottom of the Data Entry screen.

To show the detailed historical value and comments for a tag, select the value you want
from the list and tap .
To apply the selected historical comment as the current comment, select the value from
the list and tap , or choose Value > Use Previous Comment.
To apply the selected value and comment as the current value and comment, select the
value from the list and tap , or choose Value > Use Previous Value and Comment.
The tilde character indicates the values that have been added for a tag on the same tour run, as
shown in the following figure.

PI Manual Logger User Guide 163

Use PI Manual Logger Mobile

164
 View Message Logs

View Message Logs

To view a message log for a tour or tour run, tap the Log tab at the bottom of the Data Entry
screen.

On the Log tab, the following functions are available:

To refresh the log view, tap .
To enter a new log message for a tour or tour run on the Log page, tap . This opens the
Log Entry screen, shown in the following figure.

PI Manual Logger User Guide 165

Use PI Manual Logger Mobile

From the Log Entry screen, the following functions are available:
To save your entry, tap .
To cancel your entry, tap .
To select an entry from a predefined list of templates, tap .

166
 View the Audit Log

View the Audit Log

The read-only audit log shows changes made to the tour run, including tag values, tag value
timestamps, tour run timestamps, tag comments, and tour comments.
To view the Audit Log, tap the Audit tab at the bottom of the Data Entry screen.

Note: If you delete a tour run, you delete the audit log for the tour run as well.

PI Manual Logger User Guide 167

Use PI Manual Logger Mobile

Leave, Confirm, or Cancel a Signature

If a tour is configured to require a handwritten signature before saving the tour, the signature
page appears when you close the tour run.

Tap OK to save the signature and associate it with the current tour run edit event. If you tap
Cancel, the signature is not saved with the tour run.

Tap to clear the current signature screen and sign again.

Note: After you save the signature image and transfer the tour run to the PI Manual
Logger database, you can view the signature later in the Tour Run History dialog
box.

168
 Comment on Tags, Tag Groups, and Tours

Comment on Tags, Tag Groups, and Tours

To view or modify an existing comment, tap or select the Comment tab.

To enter a new comment for a tag value, tap .

PI Manual Logger User Guide 169

Use PI Manual Logger Mobile

The comment tag shows the target with which the current comment is associated. The target
can be an individual tag listed with the icon, a tag group with the icon, or the whole
tour with the icon.

Note: Tap to use any available predefined comments.

170
 View Trends on Mobile Devices

View Trends on Mobile Devices

In PI Manual Logger Mobile, static trending of archived values is supported on mobile
devices. To display a trend either (1) choose Tag > Show Trend or (2) tap on the Data
or History tabs.

Be aware of these points about trending:

If the tag uses a PI point type of Timestamp, it cannot be trended.
Trending does not include data from the tour run in progress.
On devices running Windows Mobile 2003 Second Edition and later, you can select
Trend>Rotate to toggle the screen display between portrait and landscape modes.

PI Manual Logger User Guide 171

Use PI Manual Logger Mobile

If you do not have enough archived data on your mobile device for trending, an error appears
that says Too few data to display trend and no trend is displayed.

172
 Transfer Data

Transfer Data
You can initialize a data transfer from the PC or mobile device. To download new tours onto
the mobile device, you must initiate the data transfer from the PC. For details, see
Transferring Data from the PC to a Mobile Device (page 139).

Note: Before downloading data to the device or uploading data from the device, you
must set up ActiveSync for file transfers between the mobile device and the PC.
Set up the connection management software as appropriate for your application.
You can choose the Guest Only mode or set up a partnership. Use a partnership if
you want to synchronize information, unrelated to PIML, between the device and
the computer, such as calendar, inbox, contacts, files, and so forth. Note that
Partnership synchronization is more time consuming. Also, if a partnership is set
up, then you must indicate this in PIML’s AutoSync, if you are using this
application.

Transfer Data Wirelessly

To transfer data wirelessly from the mobile device to the PC, you must have an active
network connection on the device to the target server running PI Manual Logger Web
Services.
To initiate bi-directional transfer from the mobile device, tap . After a confirmation
dialog box, the device sends your collected data to the host, and downloads any updated
tour definitions, global options, and/or user database changes.
To send collected data from the mobile device to the server only, choose File > Send
Data to Host.
To receive tours from the PI Manual Logger PC application only, choose File > Update
Data from Host.

Caution: PI Manual Logger Mobile erases all existing tour data during the Update
Data from Host step. If there is previously collected data on the mobile device
that has not yet been sent to the PI Manual Logger desktop database or to the PI
Server directly, it is erased if you tap the Yes button. To transfer collected data
prior to re-initializing your mobile's database, tap the No button and use the Send
Data to Host feature.

PI Manual Logger User Guide 173

Use PI Manual Logger Mobile

Synchronize the Time and Clock

You can manually synchronize the time and clock on the device with the target Web server
running PI Manual Logger Web Services. To synchronize the device clock, choose Tools >
Sync Date/Time. After the device is connected to the Web server, PI Manual Logger
retrieves the current date and time from the Web server and adjusts the device time
accordingly.
This feature is helpful in situations where the device clock is out of sync due to battery power
loss or other hardware failure.

174
 Transfer Data

Configure AutoSync

When AutoSync is enabled, PI Manual Logger synchronizes data with the mobile device
anytime it is cradled. Synchronized data includes uploading tour run data from the device,
sending updated tour information to the device, and updating previous values from PI Manual
Logger onto the device.

Note: AutoSync does not update the tag attributes or digital state sets.

To configure AutoSync, select from the Windows Start menu > All Programs > PI System
> PI M anual Logger > PI M L AutoSync Setup.

The options are:

Enable AutoSync: Select this check box to use the PI Manual Logger AutoSync feature.
Enable ActiveSync Partnership: If this check box is cleared, ActiveSync does not
prompt to create a partnership with the device when it is cradled.
Enable Confirmation Dialog: Select this check box to display a confirmation dialog box
before AutoSync starts. This is helpful if you need to log on and off your Windows
workstation frequently while the device is docked.
Dialog timeout: Indicates how long the confirmation dialog box appears. After the dialog
box times out, AutoSync starts. This is useful under unattended docked environments.

Note: If Dialog timeout is 0, the confirmation dialog box does not time out.

PI Manual Logger User Guide 175

Use PI Manual Logger Mobile

Windows XP or Vista Mobile Support

Note: OSIsoft recommends that you use the Mobile Database Location Setup dialog
box in order to streamline the sync process when using a Windows XP/Vista
Mobile PC to run PI Manual Logger Mobile.

With PI Manual Logger Mobile, Windows XP or Vista Mobile PCs are supported to run PI
Manual Logger Mobile in disconnected mode. Under this mode, the Mobile PC does not have
to connect to the target PI Server nor the central PI Manual Logger database in order to run
the application.
The shortcuts to run PI Manual Logger Mobile are created by default on Windows under
Start > All Programs > PI System > PI M anual Logger.
To configure your Mobile PC for data collection using PI Manual Logger Mobile:
1. Create the tours in the PI Manual Logger client.
2. In the M obile Devices menu in PI Manual Logger, select I nitialize Device Database.
Since no mobile device is connected, the output includes the line Running in
disconnected mode to file: followed by a file path.
3. Copy this file to a desired location, then specify this location in the M obile Database
Location Setup dialog box.

When transferring data from PI Manual Logger Mobile running on Windows XP/Vista
(such as a tablet PC or data entry desktop), you must wait for PI Manual Logger
Windows to check for a cradled handheld device. If it does not find a handheld device,
you must specify an alternative location, which allows you to customize the behavior of
PI Manual Logger Windows when it attempts to synchronize.

176
 Transfer Data

In the M obile Database Location Setup dialog box, follow these steps:
a. Click to browse for the folder to store your mobile database file
(Pi ml Mobi l e. sdf ). After selecting a folder, click Ok on the Browse for Folder
dialog box.
The following items now appear in the M obile Database Location dialog box:
Load from mobile device
Prompt for location
Load from file at <your selected folder>\ Pi ml Mobi l e. s df
b. Move the last entry, which you have just created, to the top of the list using the up
arrow button in the Priority group at the right side of the dialog box.
c. Click Save at the bottom of the dialog box to save your work and close the dialog
box.

Note: Wait until ActiveSync or Windows Mobile Device Center has recognized that
the device is connected and cradled before opening the Device Data
Transfer Console window. This is because there can be a slight delay that
causes PI Manual Logger to prompt you for a location if Load from mobile
device is first in the list.

4. On the Device Data Transfer screen in PI Manual Logger, transfer the tours to the
database file from the above steps.
5. Copy the file specified in step 3 to the Mobile PC. It is located in the directory specified
in the pi ml mobi l e. xml file. By default, this is \ Pr ogr am
Fi l es\ PI PC\ Pi ml Mobi l e\ .
After the application is launched, it will look similar to what you would see on a Windows
Mobile device.

PI Manual Logger User Guide 177

Use PI Manual Logger Mobile

After you have manually collected data on your Windows XP/Vista Mobile PC, you can copy
the database file (pi ml mobi l e. sdf ) back to a host system and run PI Manual Logger on
the host system to synchronize data back to the central PI Manual Logger database.

Click on the Device Tour List panel to choose the local database file you are using for
data transfer.

Note: Specify the location of the local database file in the Mobile Database Location
Setup dialog box. See Transfer Data from the PC to a Mobile Device (page 139)
for more information about specifying a mobile database location.

178
Chapter 7

Use PI Manual Logger MobilePC

An operator can collect data on a mobile PC (laptop computer or other portable system)
instead of a handheld device. As with the handheld device, the mobile PC is disconnected
from the network and cannot communicate with the PI Server while the operator is collecting
field data. Unlike the handheld device, on which PI Manual Logger Mobile is installed, the
mobile PC runs PI Manual Logger PC. With the mobile PC, the operator has access to many
of the features that are normally available on the PC client.
When the mobile PC is disconnected from the network and the operator is working offline,
the following options are available:
On the PI M L menu, open the Message log, view PI tags and digital states, switch users,
and view work requests.
On the Tours menu, execute a tour run and collect data on the mobile PC, import a tour
run from a file, view/edit data in existing tour runs.
On the M obilePC menu, transfer tours to the mobile PC from the Central SQL Server
database, choose transfer options for the mobile PC, and transfer tour runs from the
mobile PC to the Central SQL Server database.
The trend control is not available in this mode.

Collect Field Data

Before executing a tour run and collecting field data, the operator must connect to the Central
SQL Server database and download tours to the mobile PC. Follow these steps:
1. Open PI Manual Logger and verify that you are connected (on the M obilePC menu,
Work Disconnected is not checked).
2. Click M obilePC>M obilePC Data Transfer Options to verify that the Send and Receive
Options are set appropriately.
3. Click M obilePC>M obilePC Data Transfer to open the M obilePC Data Transfer
window.
4. In the upper left pane labeled Tour List, select the tour(s) to transfer to the mobile PC.

5. Click in the center Tool Strip.

6. Click in the center Tool Strip. You are now ready to execute a tour run.

PI Manual Logger User Guide 179

Use PI Manual Logger MobilePC

To execute a tour run, on the mobile PC open PI Manual Logger. Then follow these steps:
1. Select Tours>Tour Run List (M anual Data Entry and Review).
2. Select a tour from the Tour List.
3. To execute the tour run, either double-click the selected tour in the Tour List or click

on the bottom Tool Strip.

After completing the tour run, connect to the company network, and transfer your tour runs to
the Central SQL Server database. Follow these steps:
1. Click M obilePC>M obilePC Data Transfer to open the M obilePC Data Transfer
window.

2. If you have partial tour runs, click in the center Tool Strip and select the appropriate
option on the Send Options tab.

3. Click in the center Tool Strip.

4. To transfer additional tours to your MobilePC database or remove tours from your

MobilePC database, use the buttons in the center Tool Strip and click

180
Chapter 8

Security and Auditing

Manage the User Database

PI Manual Logger includes a separate user database, which is shared by the desktop
applications, the Windows Service, the PI Manual Logger Web Services component, and the
mobile device. The same level of user access control is implemented on the desktop and on
the mobile device platform.
PI Manual Logger's user database includes a list of users and user groups. Each user can
belong to multiple user groups. One user group is designated as the Administrative user
group. Users belonging to the administrative group have full access to all PI Manual Logger
features.
To open the User Database M anagement dialog box, choose PI M L > M anage User
Database. You must be a member of the administrative user group to access this feature.

PI Manual Logger User Guide 181

Security and Auditing

When you first install and configure PI Manual Logger, there is one user defined with the
user name piml and password piml. You can change the password after installation.
By default, the default user piml belongs to the PIMLADMINS user group and has full access
rights to all PI Manual Logger features.

Note: To change the default designated administrative group, choose Tools > Global
Options > Security Settings.

Types of Users

The default user, piml, belongs to the default administrative group PIMLADMINS. Any user
belonging to this administrative group has full access to all tours in the PI Manual Logger
database.
The options available in the Users pane are:

To add a new user, click .

To remove a user from the user database, click .

To change/reset the password of an existing user, select the user and click .
To change the properties of a user, double-click the user name in the User list, or select a
user and click .

182
 Manage the User Database

Note: If the Log user group membership changes check box is selected in the Global
Options dialog box (choose Tools > Global Options > Message Logging) PI
Manual Logger records all changes made to the user database in the message
logs.

If you are a member of the administrative group, it is not necessary to know a

user's password to reset it.

Single-User Mode on a Mobile Device

If you are using Windows Mobile devices to collect manual data, you can set up the device to
be single-user mode, which disables the Login dialog box on the device. For details about
single-user mode on a mobile device, see Configure a Mobile Device (page 135).

User Groups

After PI Manual Logger is installed, the default user group PIMLADMINS is created. By
default, this is the administrative group.
New users can be assigned to one or more user groups. Users have access only to the tours
that are assigned to the user groups they belong to, unless they belong to the administrative
group.
The options available in the Permissions Groups pane are the following:

To add a new user group, click .

To remove a user group, select the group name in the Permission Groups list and click
.
To change the properties of a user group, double-click the group name in the Permission
Groups pane, or select a group and click .

PI Manual Logger User Guide 183

Security and Auditing

To change the list of users belonging to a group, click the User M embership tab.

Select the user and click Add or Remove as appropriate.

184
 Manage the User Database

Associate a Tour with a User Group

To change the Full Access group and Data Entry group information for a tour:
1. In the PI Manual Logger main window, select Tours > Tour List.
2. Double-click the tour.
3. In the Tour I nfo pane within the Tour Definition dialog box, select the groups from the
Full Access Group and Data Entry Group drop-down lists.

PI Manual Logger User Guide 185

Security and Auditing

PI Server Security
PI Manual Logger communicates with and stores all information for a tour in a single PI
Server. When PI Manual Logger opens initially, it uses the default PI Server. You can change
this default server to another if necessary.
Both the PI Manual Logger Windows client and the PI Manual Logger Windows Services use
the PI SDK to communicate with PI Servers. All users require read access to the PI Server.
The users who send tour run data to the PI Server require full write access to the relevant
tags. Therefore, a PI Mapping or a PI Trust connection is required. Before you start loading
tags to PI Manual Logger, configure the server connection to use a PI Trust login or a PI
Mapping.
To configure a PI Trust, refer to the documentation for the PI Trust Editor SMT3 Plug-In.
The name for the online help file is PI Tr ust s. chm. This help file provides details for
configuring server trust connections and adding and removing PI Servers from a server list.
The following figure shows some configured trusts for a system.

PI Mapping requires PI Server version 3.4.380 or later and PI SDK 1.3.6 or later. OSIsoft
recommends using Windows security through PI Mappings. Windows security provides the
strongest authentication and full Windows account traceability in the PI Server log and audit
trail records. To configure a PI Mapping, refer to the PI Server documentation for details.
You can obtain the manual Configuring PI Server Security at the OSIsoft Download Center.

186
 PI Server Security

The following figure shows some configured identities for a system.

Server Security

In addition to the security at the PI Manual Logger application level, the PI Server allows you
to set up security at the level of the point. A PI Manual Logger user must have write access to
write tag values to the PI Server.
PI Manual Logger also provides support to ensure your data is secure. The additional security
features are:
PC-side data persistence security
Data communication security
User login on the device
PI Server security

PI Manual Logger User Guide 187

Security and Auditing

Auditing
This section describes the auditing features of PI Manual Logger.

Auditing on the PI Server

Security on the PC application is integrated with PI trusts or PI Mapping. When users log in
to a PC workstation and start PI Manual Logger, they are authenticated against the
established PI trust or PI Mapping on the currently connected PI Server. After they are
authenticated to this PI Server, they can access data in the PI Server. Furthermore, if they
enter data into the PI Server, the changes made to tag values are audited in the PI audit
database.

Auditing on User Database Changes

Administrators can audit changes in the user database, such as user password changes and
user group relationship changes. Click Tools>Global Options and select the Message
Logging tab. Select from these options:
Log user group membership changes.
Log user password change events.
Log Admin user group changes.

Auditing on Tour Definition Deletion and Creation

You can audit tour definition creation and deletion events. Click Tools>Global Options and
select the Message Logging tab. Select from these options:
Log tour definition creation events.
Log tour definition deletion events.

Auditing on Data Transfer

All successful data transfers from PI Manual Logger to PI Server is audited and logged into
the PI Manual Logger database. To view these logs, use the Message Log Viewer (page 120).

Auditing on Data Changes in PI Manual Logger

If a user makes changes to an existing tag value, its timestamp, or its comment, the action is
audited and saved in the tour run audit trail. You can view the audit trail in the Tour Run
Audit Log (page 118).

188
Appendix A

Message Logs
The following activities and events are saved in the message log for auditing purposes:
Successful or failed tour creation, modification, and deletion, including the details on
which tour and which user made the change.
Successful or failed archive action for tour run data, including details on which user was
involved in the action.
Other failed access events.
In addition, PI Manual Logger logs summary information for each user session at the
beginning and end of the session. The information includes:
The user logged on or off the PI Manual Logger system and when.
The tours were created and changed.
The number of tags that failed to archive or were overwritten during the user session.
When data is added through a mobile device, PI Manual Logger Mobile also records
messages and user session activities. After the mobile device is connected to the host (a PC or
Web Services Server), PI Manual Logger downloads the message log from the device and
saves it in the database. For details about message logging in PI Manual Logger Mobile, see
Message Log Page (page 165).

To view the history of the PI Manual Logger message log, select PI M L > M essage Log.
In the M essage Log Viewer dialog box, you can view logs in Grid View and Plain Text
View by clicking the corresponding tabs. To view all logs in the PI Manual Logger database,
click Show Saved Logs.

Note: Show Saved Logs displays 30 days at a time. Continue to press the Show Saved
Logs button to view additional days.

PI Manual Logger User Guide 189

Message Logs

PI Manual Logger Configuration Tool

In addition to the message log viewer in the main PI Manual Logger application, you can also
view the logs saved in PI Manual Logger database using the standalone PI Manual Logger
Configuration Tools. To start the Configuration Tools, select Start > All Programs > PI
System > PI M anual Logger > PI M L Configuration Tools.

Double-click View Logs. In the M essage Log Viewer dialog box, you can view the logs in
Grid View or Plain Text View by clicking the corresponding tabs.

190
Appendix B

Global Settings and Maintenance

Update Tag Attributes in the PI Manual Logger Database

To view and update all PI tags and digital states that are currently used in PI Manual Logger,
select PI M L > PI Tags and Digital States.

Note: You must manually run Update Tag Attributes whenever tag attributes or digital
states are modified on the PI Server, or use the PIML Windows Service to update
them automatically.

In the PI Tags and Digital States dialog box, you can update tag attributes, keep digital
states used in PI Manual Logger in sync with the target PI Server, update cached tag values in
the PI Manual Logger database, and send queued data to the PI Server.
To update tag attributes for individual tags, select the tag(s) you want to update, right-
click, and select Update Tag Attributes for Selected Tags.
To update tag attributes for all tags, right-click in the PI Tags page, and select Update
Tag Attributesfor All Tags. This may be a time-consuming process, depending on the
number of tags in the database.

PI Manual Logger User Guide 191

Global Settings and Maintenance

To remove tags from PI Manual Logger, select the tag(s), right-click and select Remove
Selected Tags from PI M L. Use this to remove:
Tags that were removed from the PI Server since they were added to PI Manual
Logger
Tags that are no longer in use in PI Manual Logger.
To update digital states, click the PI Digital States tab, right-click anywhere in the page,
and select Update Digital States. Always update digital states before running a tour.
Tab Relevant Actions
PI Tags Displays all tags within all tours currently defined.
PI Digital States Displays the digital states included in all tours.
Queued Data
Displays all queued (future) data waiting to be sent to the PI Server. Click to
send the data.
Cached Values Displays the cached values for the selected tags on the PI Tags tab when you click
on the toolbar of the PI Tags tab. You can also right-click in the PI Tags tab and
select Show Cached Value.
Archive Values Displays the archived values for the selected tags on the PI Tags tab when you
click on the toolbar of the PI Tags tab. You can also right-click in the PI Tags
tab and select Show Archive Data.
Concordance Displays all tours in which a tag is used for tags selected in the PI Tags tab when
you click on the toolbar of the PI Tags tab. You can also right-click in the PI
Tags tab and select Show Tour Tag Concordance.

You can display trending for any selected tag on the PI Tags tab when you click on the
toolbar or right-click in the PI Tags tab and select Show Trend for Selected Tags.

192
 Archive Values

Archive Values
The Archive Values page displays the archived values for a PI tag. To display these values,
select PI M L > PI Tags and Digital States, and in the PI Tags tab, right-click a tag and
select Show Archive Data.
In the Archive Values tab that appears, you can display trends, show annotation details, add
a comment to an existing tag value, or delete selected values from the PI Server.

Note: If your user account does not have permission to delete PI tag values from the PI
Server, the menu item is unavailable. For details about account permissions, see
Configure Global Options (page 43).

PI Manual Logger User Guide 193

Global Settings and Maintenance

Queued Data
To send queued data to the PI Server, select PI M L>PI Tags and Digital States and click the
Queued Data tab. Then, right-click anywhere on the page, and select Send to PI . This action
sends all queued data that is now viable (less than 10 minutes into the future), not merely the
selected data.

In addition to this feature, PI Manual Logger Windows Services also sends queued data to the
PI Server automatically on a scheduled basis after the timestamp of the queued data becomes
current.

PI Manual Logger Maintenance

OSIsoft recommends that you periodically remove old tour runs that have been archived (that
is, sent to the PI Server) in order to improve performance of PI Manual Logger.

194
Appendix C

Tour Migration
The PI Manual Logger Tour M igration Tool is an add-on application for PI Manual Logger
2.x that allows you to migrate existing PI Manual Logger 1.4.x tour data to the PI Manual
Logger 2.x database format.

Note: If you are running PI Manual Logger version 1.3 or earlier, you must use PIML
1.4.x to migrate to the 1.4 database format first, and then migrate to 2.x.

PI Manual Logger User Guide 195

 Back Up 1.4.x Tour Definitions
If you are currently using PI Manual Logger 1.4.x and want to upgrade to the newest version,
be sure to back up your existing 1.4.x tour definition database first. The 1.4.x tour definition
database is a Microsoft Access 97 database file, which by default is named pi ml s 135. mdb.
To check the location of your current PI Manual Logger 1.4.x database, start PI Manual
Logger 1.4.x and select PI M L > Administration > Attach to another PI M L Data file.

After you know the location of your database file, save the database file to a back-up storage
location, such as a separate backup server, a network share, or a different folder on your PC.
You can upgrade the tour definition backups later to the new version and the new data store
using the PI Manual Logger Tour M igration Tool.

Note: Not all information in tour definitions is migrated into the new database format. For
details, see What is Not Migrated (page 200).

PI Manual Logger User Guide 197

Tour Migration

Migrate Tour Data

Note: Before importing tour data into the PI Manual Logger 2.x database, you must set
up the correct SQL connection to your SQL Server database. For details, see
section Configure SQL Server (page 18).

To migrate data from PI Manual Logger 1.4.x tour definitions:

1. Select Start > All Programs > PI System > PI M anual Logger > PI M L Tour
M igration Tools.

2. The PI Manual Logger 2010 Tour Migration Tool allows you to maintain the tag
sequence order as defined in tours migrated from PIML 1.4. Select check box, Keep tag
sequence order and disregard group order if you want to preserve tag sequence order.
3. Click Browse to locate your PI Manual Logger 1.4.x Access database. The database file
must have the . mdb extension.

198
 Migrate Tour Data

4. Click Start to begin the tour migration process. The Assign Permission Groups dialog
box appears.

5. Choose the appropriate full permission and data entry permission groups for all tours that
are being migrated. For details about permission groups, see section Manage the User
Database (page 181).
The Tour M igration Tool window shows the migration process details.

PI Manual Logger 2.x records all tour migration events in its Message Logs. Use the PI
Manual Logger Message Log Viewer (page 120) for auditing or reviewing purposes.
After a tour has been migrated with the Keep tag sequence order and disregard group
order check box selected, users can manually sequence tags. See section Reorder Tags and
Tag Groups (page 91) for details.

PI Manual Logger User Guide 199

Tour Migration

What Is Migrated
The following tour information is migrated to the PI Manual Logger 2.x database format:
Tour name
Tour description
All tags defined in the tour
All comment tags
Tag limit specifications
All equipment defined in the tour (migrated as Tag Group Names)
All barcodes defined in the tour
All location text defined in the tour (migrated as Operator Instructions)
All system states (digital states) associated with the tour

What Is Not Migrated

The following tour information is not migrated to the PI Manual Logger 2.x database format:
Tour options
Tour permission groups and permission levels
Tour collection specifications
Tour run data

200
Appendix D

Custom Web Service Access

You can develop your own Web services application and see the operations that are exposed
through the Web service. The Internet Information Services (IIS) setup differs, depending on
your operating system.
Configure IIS in Windows XP/2003 (page 202)
Configure IIS in Windows Vista/Windows 7 (page 204)
Configure IIS in Windows Server 2008 (page 207)

Note: A restart of the IIS services may be necessary after installation and configurations
are complete.

After the IIS configuration is complete, follow these additional steps in section Post-IIS
Configuration Procedures (page 209). They are not dependent on your operating system.

PI Manual Logger User Guide 201

Custom Web Service Access

Configure IIS in Windows XP/2003

To configure IIS in Windows XP/2003:
1. Open I nternet I nformation Services (I I S) for Windows XP or I nternet Services
M anager for Windows 2003 from Start > Control Panel > Administrative Tools.
2. Click Web Sites > Default Web Site.
3. Right-click Default Web Site and then select New > Virtual Directory.
4. Follow the steps in the Virtual Directory Creation Wizard. Verify that the settings are
appropriate for your setup.
This includes: providing an alias for the virtual directory (for example,
PimlWebServices), providing a local path to the Web content (typically
PI PC\ Pi ml WebSer vi c es ), and setting access permissions for the virtual directory.
5. After the Virtual Directory Creation Wizard is complete, right-click the Manual
Logger Web Services virtual directory and select Properties.
6. Verify the settings on each tab. Taking special note of the settings on the ASP.NET
(which is required), Virtual Directory, and Directory Security tabs.

202
 Configure IIS in Windows XP/2003

7. Set the authentication methods. To access the Authentication M ethods dialog box, click
the Directory Security tab on the PimlWebServices Properties dialog box and then
navigate Anonymous access and authentication control > Edit.

PI Manual Logger User Guide 203

Custom Web Service Access

Configure IIS in Windows Vista/Windows 7

To configure IIS in Windows Vista/Windows 7:
1. Verify that ASP.NET is installed by selecting Start > Control Panel > Programs and
Features for Vista or Start > Control Panel > Programs > Programs and Features for
Windows 7, then select Turn Windows features on or off. Navigate to I nternet
I nformation Services > World Wide Web Services > Application Development
Features. If the default settings were used during the IIS installation, ASP.NET might
not have been installed.

2. Open Internet Information Services (IIS) Manager from Start > Control Panel >
Administrative Tools for Vista or Start > Control Panel > System and Security >
Administrative Tools for Windows 7.
3. If you plan to use Application Pools, then open the Application Pools and configure
appropriately for your environment. We recommend that you refer to the Microsoft IIS
documentation.

204
 Configure IIS in Windows Vista/Windows 7

4. Select Web Sites > Default Web Site.

5. Right-click Default Web Site and select New > Add Application.
6. Provide the information for adding a Web Application.
7. After the Web Application creation is complete, select the Manual Logger Web Services,
for example, PIMLWebServices, to view the different configuration areas.
8. Verify the settings for the PimlWebServices. Take special note of the Authentication
and Handler M appings areas.

PI Manual Logger User Guide 205

Custom Web Service Access

206
 Configure IIS in Windows Server 2008

Configure IIS in Windows Server 2008

To configure IIS in Windows Server 2008:
1. Verify ASP.NET is installed by running the Server M anager from Start >
Administrative Tools. Select the appropriate server and then navigate to Roles > Web
Server (I I S). Verify that ASP.NET is installed in Role Services > Application
Development. If the default settings were used during the IIS installation, ASP.NET may
not have been installed. To install ASP.NET, select Add Role Services and follow the
Add Role Services Wizard.
2. After ASP.NET role service is installed, the Manual Logger Web Services Web
Application can be added using the Internet Information Services (IIS) Manager.
3. Open Internet Information Services (IIS) Manager from Start > Administrative Tools.
If the IIS Manager is not displayed in the Administrative Tools list, it needs to be added
via the Server M anager console through the Add Role Services feature.
4. If you plan to use Application Pools, then open the Application Pools and configure
appropriately for your environment. We recommend that you refer to the Microsoft IIS
documentation.

5. Click Sites > Default Web Site.

6. Right-click Default Web Site and then select New > Add Application.
7. Provide the information for adding a Web Application.

PI Manual Logger User Guide 207

Custom Web Service Access

8. After the Web Application creation is complete, select the Manual Logger Web Services,
for example, PimlWebServices) to view the different configuration areas.
9. Verify the settings for the PimlWebServices. Take special note of the Authentication
and Handler M appings areas.

208
 Post-IIS Configuration Procedures

Post-IIS Configuration Procedures

After the IIS configuration is complete, perform the following steps:
1. Navigate to the PI PC\ Pi ml WebSer vi c es folder and run the Pi ml Tool s . ex e to
set the SQL Server database login information.

2. Double-click SetUp Connection. The Database Connection Setup dialog box appears,
as shown in the following figure.

3. In the SQL Server Name field, enter the computer name and SQL Server Name
(Instance Name), if necessary. In the figure, the computer name is Weathertop. Since this
example uses SQL Express, the default Instance Name also appears: SQLExpress.
4. Make sure the Database Name is PIMLWindows, as shown in the figure.

5. If Windows Authentication mode is configured for your SQL Server instance, then check
the Use my Windows credentials check box in PI M anual Logger’s Database
Connection Setup dialog box. Microsoft recommends using Windows Authentication
when possible. Otherwise, deselect this check box and provide the appropriate SQL
Server login information.

PI Manual Logger User Guide 209

Custom Web Service Access

6. Click Test to verify the connection and click OK in the message box that appears.
7. Click Apply to close the PI M anual Configuration Tools dialog box.
8. Test the Web Services by entering the following URL in a Web browser
http://<YourWebServer>/PimlWebServices/PimlWebServices.asmx
9. Click Test Connection to verify your connection to the database and PI Server.

A successful connection results in a browser window that confirms your connection.

210
Appendix E

Install and Configure SQL Server 2008 / 2005

Express Edition
Microsoft SQL Server Express is a free and easy-to-use database product that is based on
SQL Server technology. This section details the steps to install and configure SQL Server
Express for use with PI Manual Logger.

System Requirements
Download and install the following components before installing SQL Server Express:
The latest service packs on your Windows operating system
Microsoft .NET Framework 2.0
You can download SQL Server Express from the Microsoft Web site. In addition, OSIsoft
recommends that you download Microsoft SQL Server Management Studio Express, which
provides a graphical interface to manage basic database administration tasks.

PI Manual Logger User Guide 211

Install and Configure SQL Server 2008 / 2005 Express Edition

Install SQL Server Express

To install SQL Server Express:
1. Double-click the installation executable file to start the installation.
2. Follow the instructions to install the prerequisite components.
3. In the Feature Selection screen, specify the components to install as shown in the
following figure. Note that figures for SQL Server 2008 Express are similar to the ones
used in this procedure.

4. If you install SQL Server Express using Advanced Options, the I nstance Name screen
appears. The default SQL Server path is:
Ser ver Name\ SQLEx pr es s
You can specify the database server to a different path, such as
Ser v er Name\ PI MLSQLExpr es s

Note: Refer to the Microsoft documentation if you choose the Named Instance
button instead of using the default Instance.

In the Authentication M ode screen, we recommend that you refer to Microsoft security
recommendations.
5. Make a note of the database server path, as it is the path that the PI M anual Logger SQL
Server Configuration dialog box uses.

212
 Use SQL Server Management Studio Express

Use SQL Server Management Studio Express

To start SQL Server Management Studio Express, choose Start > All Programs > M icrosoft
SQL Server 2005 (2008) > SQL Server M anagement Studio Express. In the Connect to
Server dialog box, specify the SQL Server instance you want to connect to and the
authentication mode you want to access.

Log in to the SQL Server database. Note that the Server Name field contains the computer
name + \SQLEXPRESS because the Default Instance was selected during installation of the
database. To attach or manage the PI Manual Logger SQL Server database, you must have
administrative permissions to the server.

Refer to the post-installation procedure Attaching Template Files for SQL Server 2008 / 2005
(SQL Express) (page 19) for steps to attach the PI Manual Logger database template file.
After you attach the database file, refer to the Microsoft SQL Server documentation for
adding users to access the PI Manual Logger database.

PI Manual Logger User Guide 213

Install and Configure SQL Server 2008 / 2005 Express Edition

Remote Connection to SQL Server Express

If you plan to install SQL Server Express on a computer that is different from the workstation
where PI Manual Logger is installed, configure the Surface Area tools to allow remote PCs
to connect to the SQL Server.

Set the client connections to Local and remote connections. In addition, set SQL Browser
Services Startup type to Automatic and set Service status to Running.

214
Appendix F

Conditional Manual Data Entry (CMDE)

Conditional Manual Data Entry (CMDE) provides a set of functions to determine if a tag
should be collected based on conditions during a tour run. These conditions can include
current values of other tags, previous values of tags, the time a tag was collected, as well as
many other options.
CMDE can be defined for an individual tag or for a group of tags. CMDE for individual tags
takes precedence over any group CMDE. The Conditional Specification field can be
accessed from the Tag Configuration dialog box in the following ways.
For individual conditional specification, select the Tag Entry Options tab.

PI Manual Logger User Guide 215

Conditional Manual Data Entry (CMDE)

For group conditional specification, select a group from the Tree View and then select the
Tag Group Configuration tab.

After the conditional specification is entered, always verify your formula by clicking .
Note that if you use an invalid function, the function is displayed in red font.
An invalid formula elicits an error or warning. For example, if you use a PI tag that does not
exist within tour, you receive a warning. A warning is displayed because you can add the tag
to the tour at a later time (prior to running the tour) and revalidate the conditional
specification.
To activate the editor's IntelliSense feature, use these key combinations:
Ctrl + Shift. Prompts with a list of CMDE functions along with their descriptions.
Ctrl + t. Prompts with a list of tags in the tour.
Ctrl + o. Prompts with a list of CMDE operators.

216
 Data Types

The following figure illustrates the Ctrl + Shift option.

Data Types
Data Type Description and Examples
Double A floating point number
Integer An integer number
String Must be surrounded by double quotes.
Example: "ML Tag 101"
Note: CMDE has a 1000 character limit.
Date When dates are combined with numbers, they are
treated as doubles. 1.0 = 24 hours.
Example: TourTime() - 15
This means 15 days (360 hours) before the tour
time.
Example: TourTime() + 3.0 /24.0
This means 3 hours after the tour time.
Boolean Either True or False
Unknown Represents an indeterminate value

PI Manual Logger User Guide 217

Conditional Manual Data Entry (CMDE)

Supported Operators
The table below lists the operators that can appear in the CMDE in order of operation
precedence, with the highest precedence operators listed first. Operators are evaluated left to
right.
Operator Name Examples
() Parenthesis (A+ B)
F(a,b,c,…) Function CurrentValue("Tag101")
^ Power A^B

* Multiplication A*B

/ Division A/B

% Modulus A%B

+ Addition A+B

- Subtraction A-B

< Less Than A<B

<= Less Than or Equal A <= B

> Greater Than A>B

>= Greater Than or Equal A >= B

== Equality A == B

!= Inequality A != B

&& Logical AND A && B

|| Logical OR A || B

218
 Supported Functions

Supported Functions
This section lists the functions that are supported in the CMDE, along with a short description
and example(s) about each function.

ClockSchedule

Use any defined clock scheduling. If no clock scheduling is defined, it will have the same
effect as Col l ect Now.
Format
Cl ock Schedul e( )
Parameters
None

CollectNow

Returns Col l ec t Now value. Used in conjunction with the I F function as a return value.
Format
Col l ec t Now( )
Parameters
None

CurrentTime

Returns the current time stamp for the value collected in the tour for the TagName argument.
The tag must be part of the current tour. If the timestamp cannot be determined, unknown is
returned.
Format
Cur r ent Ti me( TagName)
Parameters
Argument Data Type Description
TagName String The name of any PI tag in the current tour.

Example
Cur r ent Ti me( " Pi ml DemoTag" )
This example returns the timestamp for the current value for the tag named
Pi ml DemoTag. If the timestamp for the current value for the tag cannot be found,
Unknown is returned.

PI Manual Logger User Guide 219

Conditional Manual Data Entry (CMDE)

CurrentValue

Returns the current value collected in the tour for the TagName argument. The tag must be
part of the current tour. If the value cannot be determined, Unknown is returned.
Format
Cur r ent Val ue( TagName)
Parameters
Argument Data Type Description
TagName String The name of any PI tag in the current tour.

Example
Cur r ent Val ue( " Pi ml DemoTag" )
This example returns the current value for the tag named Pi ml DemoTag. If the current
value for the tag cannot be found, Unknown is returned.

DigCode

Returns the digital code for the digital state passed. If only one argument is passed, the digital
state must be defined as part of the Digital States for the tour. If a second argument is passed,
the digital state must be one of the states for the tag passed as the second argument. The tag
passed as the second argument must be a digital tag (PointType = "Digital")
Format
Di gCode( Di gi t al St at e, [ TagName] )
Parameters
Argument Data Type Description
DigitalState String The name of any tour digital state in the current tour.
TagName String Optional argument. A digital tag name included within
the tour that belongs to the user-defined digital state
set to which the DigitalState argument belongs.
TagName is not required when the DigitalState
argument is a SYSTEM digital state that is
specifically included in the tour.
TagName is required when the DigitalState argument
is a digital state from a user-defined digital state set.

Examples
Example 1
Di gCode( " Uni t Down" )
This example returns the digital code for the tour digital state "Uni t Down".

220
 Supported Functions

Example 2
Di gCode( " Of f " , " Pi ml Di gi t al DemoTag" )
This example returns the digital code for the Of f digital state of the
Pi ml Di gi t al DemoTag digital tag.
Example 3
I f ( Cur r ent Val ue( " T2002. ML" ) == Di gCode( " Manual " ,
" Di gi t al ModesTag" ) , Ski p( ) , Col l ect Now( ) )
OR
I f ( Cur r ent Val ue( " T2002. ML" ) == Di gCode( " Manual " , " T2002. ML" ) ,
Ski p( ) , Col l ec t Now( ) )
where T2002. ML and Di gi t al ModesTag are digital tags included in the tour and are
associated with the "Modes " digital state set that includes the "Manual " state.
Example 4
I f ( Cur r ent Val ue( " T1001. ML" ) == Di gCode( " Uni t Down" ) , Sk i p( ) ,
Col l ec t Now( ) )
where "Uni t Down" is a SYSTEM digital state that is included in the tour.
Note that typically the first tag in a group represents the status of the equipment. This can be
a digital state, such as on/ of f , r unni ng/ out of ser vi ce, and so forth. If this status
shows the equipment is off, no other tags need to be collected.
Assume the following Tag and Group structure in your Tour, where R- 200 is a group and
T1001. ML, T1002. ML, and T1003. ML are tags within this group:
R- 200
- T1001. ML
- T1002. ML
- T1003. ML
If the first tag in the group, T1001. ML, represents the status of the equipment for the whole
group, then the above CMDE formula can be assigned at the group level, R- 200. In this
case, remember:
No CMDE is applied to the first tag, so T1001. ML is always due for collection.
If the tag T1001. ML is assigned the SYSTEM digital state ‘ Uni t Down’ during a tour
run, then tags T1002. ML and T1003. ML will be skipped. Otherwise, they will be due
for collection.

PI Manual Logger User Guide 221

Conditional Manual Data Entry (CMDE)

Another alternative is to create a subgroup, R- 200a, within group R- 200 such as:
R- 200
T1001. ML
R- 200a
- T1002. ML
- T1003. ML
where the above CMDE formula is assigned to subgroup R- 200a. In this case, remember:
No CMDE is applied to the first tag, so T1001. ML is always due for collection.
If the tag T1001. ML is assigned the SYSTEM digital state ‘ Uni t Down’ during a
tour run, then the tags within subgroup R- 200a, which include T1002. ML and
T1003. ML, will be skipped. Otherwise, they will be due for collection.
An additional alternative is to associate the CMDE formula with each tag within the group to
which its collection status is dependent.

If

Returns the value of the Tr ueResul t argument if the Condition argument is "true", and
returns the value of the El s eRes ul t argument if the Condition argument is "false."
Format
I f ( Condi t i on, Tr ueRes ul t , El seRes ul t )
Parameters
Argument Data Type Description
Condition Boolean Valid expression that will evaluate to True or False.
TrueResult Any Any expression that will be returned when Condition
argument evaluates to True.
ElseResult Any Any expression that will be returned when Condition
argument evaluates to False.

Example
I f ( Cur r ent Val ue( " TI 001. ML" ) < 32, Col l ect Now( ) , Ski p( ) )
This example prompts for data collection when the current value of the TI 001. ML tag is
less than 32; otherwise the tag is not prompted for collection.

222
 Supported Functions

IsUnknown

Returns "true" if the expression cannot be evaluated due to missing or unknown data,
otherwise returns "false."
Format
I sUnk nown( Expr es si on)
Parameters
Argument Data Type Description

Expression Any Any valid expression

Example
I sUnk nown( Pr ev i ousTi me( " TI 001. ML" ) )
This example returns "true" if the previous time of the tag TI 001. ML is unknown, that
is, could not be found, otherwise it returns "false."

LastArchivedTime

Returns the timestamp of the last archived value for the TagName argument. This TagName
argument can be any PI tag in the PI Server and does not necessarily need to be in the tour. If
the last timestamp cannot be determined, Unknown is returned.
Format
Las t Ar chi v edTi me( TagName)
Parameters
Argument Data Type Description
TagName String The name of any PI tag in the PI Server. The tag
does not necessarily need to be in the tour.

Example
Las t Ar chi v edTi me( " Pi ml DemoTag" )
This example returns the timestamp for the last archived value for the tag named
Pi ml DemoTag. If the timestamp for the last archived value cannot be found for the tag,
then Unknown is returned.

PI Manual Logger User Guide 223

Conditional Manual Data Entry (CMDE)

LastArchivedValue

Returns the last archived value for the TagName argument. This TagName argument can be
any PI tag in the PI Server and does not necessarily need to be in the tour. If the last value
cannot be determined, Unknown is returned.
Format
Las t Ar chi v edVal ue( TagName)
Parameters
Argument Data Type Description
TagName String The name of any PI tag in the PI Server. The tag
does not necessarily need to be in the tour.

Example
Las t Ar chi v edVal ue( " ML Tag 101" )
This example returns the last archived value for the tag named ML Tag 101. If the last
archived value cannot be found for the tag, then Unknown is returned.

PreviousTime

Returns the time stamp of the last collected value from previous tours for the TagName
argument (for the timestamp of the tag in the current tour, use the Cur r ent Ti me function).
The tag must be part of the current tour. If the last timestamp cannot be determined,
Unknown is returned.
Format
Pr evi ous Ti me( TagName)
Parameters
Argument Data Type Description
TagName String The name of any PI tag in the current tour.

Example
Pr evi ous Ti me( " TI 001. ML" )
This example returns the timestamp for the latest previous value of the tag named
TI 1001. ML. If the timestamp for the previous value cannot be found for the tag,
Unknown is returned.

224
 Supported Functions

PreviousValue

Returns the last collected value from previous tours for the TagName argument (for value of
the tag in the current tour, use the Cur r ent Val ue function). The tag must be part of the
current tour. If the last value cannot be determined, Unk nown is returned.
Format
Pr evi ous Val ue( TagName)
Parameters
Argument Data Type Description
TagName String The name of any PI tag in the current tour.

Example
Pr evi ous Val ue( " TI 001. ML" )
This example returns the previous value for the tag named TI 001. ML tag. If a previous
value cannot be found, Unk nown is returned.

Skip

Returns Sk i p value. Use in conjunction with the I F function as a return value.

Format
Ski p( )
Parameters
None

TourTime

Returns the time set as the tour time.

Format
Tour Ti me( )
Parameters
None
Example
Tour Ti me( )

PI Manual Logger User Guide 225

Conditional Manual Data Entry (CMDE)

Sample Usage
The following provides examples using the CMDE formula for conditional data entry.
Example
I f ( I s Unknown( Cur r ent Val ue( " Tag1" ) ) , Ski p( ) ,
I f ( Cur r ent Val ue( " Tag1" ) >175, Cl oc kSc hedul e( ) , Ski p( ) ) )
If the value of Tag1 is not filled in for the tour yet then skip data collection, otherwise, if
the current value is greater than 175, use the Clock Scheduling to determine the tag due
status, if the current value is not greater than 175, then skip data collection.
Example
I f ( Cur r ent Val ue( " Tag1" ) +Cur r ent Val ue( " Tag2" ) <=100, Col l ec t Now( ) ,
Ski p( ) )
If the sum of current values for Tag1 and Tag 2 is less than or equal to100, then collect
the data, otherwise, skip data collection.
Example
I f ( Cur r ent Val ue( " Tag1" ) ==Di gCode( " OPEN" , " Tag1" ) | |
Cur r ent Val ue( " Tag2" ) ! = Di gCode( " St opped" , " Tag2" ) , Col l ect Now( ) ,
Ski p( ) )
If the current value of Tag1 is OPEN or the current value of Tag2 is not St opped, then
collect the data; otherwise, skip data collection.
Example
I f ( Cur r ent Val ue( " Tag1" ) <=Di gCode( " St at e50" , " Tag1" ) &&
Cur r ent Val ue( " Tag1" ) >= Di gCode( " St at e10" , " Tag1" ) ,
Cl ock Schedul e( ) , Sk i p( ) )
If the current value of Tag1 is between St at e10 to St at e50 inclusive, use the Clock
Scheduling to determine the tag due status; otherwise, skip data collection.
Example
I f ( Tour Ti me( ) - Las t Ar c hi v edTi me( " Tag1" ) >7, Col l ect Now( ) ,
Ski p( ) )
If Tag1 has no archive values in the last 7 days then collect the data; otherwise, skip data
collection.
Example
I f ( Tour Ti me( ) - Pr ev i ousTi me( " Tag1" ) >7, Col l ec t Now( ) , Sk i p( ) )
If Tag1 has not been collected for a previous tour in the last 7 days then collect the data;
otherwise, skip data collection.

226
 Limitations

Limitations
The total number of characters (including spaces) of a CMDE formula cannot exceed 1000 to
save database space. If a formula has more than 1000 characters, PIML displays a validation
error message, automatically truncates extra characters, and validates against only the first
1000 characters of the formula.
CMDE is not case-sensitive and spaces are optional.

PI Manual Logger User Guide 227

Appendix G

Manual Creation of PI Tags

PI Manual Logger uses PI tag definitions to create the tour definitions. These tags must be
created in your PI Server before they can be used in PI Manual Logger. You can create the PI
tags using tools such as PI System Management Tools (PI SMT) or PI Tag Configurator in
Microsoft Excel. For more information about creating PI points, see the reference material on
managing PI points in the Introduction to PI Server System Management documentation,
which is available from the OSIsoft Technical Support Web site.
PI Manual Logger only uses a few of the tag attributes in the PI System. This list describes
how the PI tag attributes affect PI Manual Logger.
1. Point Name: Tag Attribute
PI Manual Logger has no special restrictions on the point name. However, if you are
using PI Manual Logger Mobile or Conditional Manual Data Entry, you may want to use
shorter point names than usual due to the limitations of the mobile device display and
CMDE formula lengths.
2. Class of Point: PtClass Attribute
PI Manual Logger tags must be classic points.
3. Data Type of Point: PointType Attribute
PI Manual Logger supports the following Point Types: Float16, Float32, Float64, Int16,
Int32, Digital, String, and Timestamp.
4. Data Source: PointSource Attribute
PI Manual Logger can use tags from any point source. Using the same point source as an
interface can result in errors in the interface and invalid data being written to tags. It is
common to use point source L for PI Manual Logger tags, because this is the default
point source for lab and manual input tags.
5. Location Attributes
PI Manual Logger does not use any of the location number attributes. If needed, they can
be used to help identify tags for searches during tour creation. For instance, Location1 is
commonly used to identify the instance of an interface that a tag corresponds to. If you
have multiple PI Manual Logger systems connected to a single PI Server, each with their
own tours and tags, you could assign the tags a Location1 value corresponding to the PI
Manual Logger system where they are used.
6. Exception Specifications
PI Manual Logger does not use exception so these settings are not relevant.

PI Manual Logger User Guide 229

Manual Creation of PI Tags

7. Compression Specifications
PI Manual Logger data will be subject to compression if the value being written is the
newest value for the tag. Compression does not apply when writing values older than the
current snapshot of the tag, such as historical values. See the section on compression
specifications in the Introduction to PI Server System Management documentation for
more information on compression.
8. Point Value Range: Zero, Span and Typical Value
PI Manual Logger does not use the Zero, Span, or Typical Value, but they are shown in
PI Manual Logger to help the data entry user.
9. Configuring Shutdown Events: Shutdown
The shutdown attribute controls whether the PI Server writes a value of Shutdown to the
PI tag whenever the server is shut down. Although it has no direct effect on PI Manual
Logger, you may set it according to your preferences for your PI Manual Logger tags.
10. Point Security: PtOwner, PtGroup, PtAccess, DataOwner, DataGroup, DataAccess
PI Manual Logger must have read and write access to data for all the tags it is configured
to use. For more information on configuring PI tag security, see the section on point
security in the Introduction to PI Server System Management documentation.

230
Appendix H

Upgrading PI Manual Logger

This section describes how to upgrade your version of PI Manual Logger.

All Users Must Run the Same Version

After a PI Manual Logger database upgrade, all users must have the same version of the
software when accessing the same instance of the PI Manual Logger database.

Before You Upgrade

It is highly recommended that you do the following before upgrading your version of PI
Manual Logger:
Back up your database.
Send all existing tour run data to PI.

Upgrade a Previous Release of PI Manual Logger 2.x

To upgrade from a previous release of PI Manual Logger 2.x, run the provided set-up
executable program.
If you are upgrading from 2.x releases prior to 2.1.0.22, you must reconfigure your SQL
server connection after installation using the PI Manual Logger Configuration Tools for the
following components:
PI Manual Logger Windows Client
PI Manual Logger Windows Service (an optional component), and
PI Manual Logger Web Services (an optional component)
This is due to encryption of the SQL Server connection information within the configuration
files.

PI Manual Logger User Guide 231

Upgrading PI Manual Logger

For details about configuring the SQL Server connection for the PI Manual Logger Windows
client and Windows Service, refer to the PIML Windows Services and SQL Server (page 19)
section.
For details about configuring the SQL Server connection for the PI Manual Logger Web
Service, refer to Appendix Custom Web Service Access (page 201), section Post-IIS
Configuration Procedures.
The first time you run the new version of Manual Logger, the user must have db_owner
privileges to upgrade the SQL Server schema for the PI Manual Logger database instance.

Upgrade a Previous Release of PI Manual Logger 1.x

An upgrade from PI Manual Logger 1.x is not supported. We recommend that you remove
version 1.x of PI Manual Logger from the system before installing PI Manual Logger 2.x.
There is support for upgrading the PI Manual Logger 1.x database information to the PI
Manual Logger 2.x database with some limitations. See Appendix Tour Migration (page 195)
for more information about the migration options.

Upgrading PI Manual Logger for Mobile Devices

Upgrading the software on the mobile device is not supported. You must remove the
currently installed version and then install a newer version. Follow this general procedure:
1. Transfer all tour run data that you need to save.
2. Cradle the mobile device and open your PC operating system's Remove Program feature.
For Windows Vista (or later) operating systems, click Control Panel>Programs and
Features.
For earlier Windows operating systems, click Control Panel>Add or Programs.
3. Select PI Manual Logger Mobile for removal. This removes PI Manual Logger Mobile
from the PC and the mobile device. It also removes SQL Server Compact Edition and
.NET Compact Framework from the device for Windows Mobile 5 or earlier devices.
SQL Server Compact Edition and .NET Compact Framework are installed in ROM on a
WM6 device.

To remove PI Manual Logger Mobile from multiple devices, use the Remove Programs
feature on each device. Click Start > Settings > System > Remove Programs and
remove OSIsoft PI Manual Logger Mobile.
For Windows Mobile 5 or earlier devices, repeat these steps to remove Microsoft SQL
Server 2005 Compact and Microsoft .NET CF 2.0.

232
 Note: On Pocket PC 2003 devices, a hard/cold reset on each mobile device
removes PI Manual Logger Mobile components, including SQL Server
Compact Edition and .NET Compact Framework, in addition to other custom
installed applications. Windows Mobile 5 and greater devices provide the
concept of persistent storage, which means these devices do not lose data if
the device experiences a cold boot or power loss.

4. Install the new version of PI Manual Logger Mobile with SQL Server Compact Edition
and .NET Compact Framework 2.0. Note that Windows Mobile 6 devices are pre-loaded
with SQL Server Compact Edition and .NET Compact Framework 2.0, so there is no
need to install these two components. For information about installation on additional
devices, see section Install on Multiple Devices (page 133).

PI Manual Logger User Guide 233

Appendix I

Technical Support and Resources

You can read complete information about technical support options, and access all of the
following resources at the OSIsoft Technical Support Web site:
http://techsupport.osisoft.com

Before You Call or Write for Help

When you contact OSIsoft Technical Support, please provide:

Product name, version, and/or build numbers
Computer platform (CPU type, operating system, and version number)
The time that the difficulty started
The log files at that time

Help Desk and Telephone Support

You can contact OSIsoft Technical Support 24 hours a day. Use the numbers in the table
below to find the most appropriate number for your area. Dialing any of these numbers will
route your call into our global support queue to be answered by engineers stationed around
the world.
Office Location Access Number Local Language Options
San Leandro, CA, USA 1 510 297 5828 English
Philadelphia, PA, USA 1 215 606 0705 English
Johnson City, TN, USA 1 423 610 3800 English
Montreal, QC, Canada 1 514 493 0663 English, French
Sao Paulo, Brazil 55 11 3053 5040 English, Portuguese
Frankfurt, Germany 49 6047 989 333 English, German
Manama, Bahrain 973 1758 4429 English, Arabic
Singapore 65 6391 1811 English, Mandarin
86 021 2327 8686 Mandarin
Perth, WA, Australia 61 8 9282 9220 English

PI Manual Logger User Guide 235

Technical Support and Resources

Support may be provided in languages other than English in certain centers (listed above)
based on availability of attendants. If you select a local language option, we will make best
efforts to connect you with an available Technical Support Engineer (TSE) with that language
skill. If no local language TSE is available to assist you, you will be routed to the first
available attendant.
If all available TSEs are busy assisting other customers when you call, you will be prompted
to remain on the line to wait for the next available TSE or else leave a voicemail message. If
you choose to leave a message, you will not lose your place in the queue. Your voicemail will
be treated as a regular phone call and will be directed to the first TSE who becomes available.
If you are calling about an ongoing case, be sure to reference your case number when you call
so we can connect you to the engineer currently assigned to your case. If that engineer is not
available, another engineer will attempt to assist you.

Search Support

From the OSIsoft Technical Support Web site, click Search Support.
Quickly and easily search the OSIsoft Technical Support Web site's support solutions,
documentation, and support bulletins using the advanced MS SharePoint search engine.

E-Mail–Based Technical Support

[email protected]
When contacting OSIsoft Technical Support by e-mail, it is helpful to send the following
information:
Description of issue: Short description of issue, symptoms, informational or error
messages, history of issue.
Log files: See the product documentation for information on obtaining logs pertinent to
the situation.

Online Technical Support

From the OSIsoft Technical Support Web site, click Contact Us > M y Support > M y Calls.
Using OSIsoft's Online Technical Support, you can:
Enter a new call directly into OSIsoft's database (monitored 24 hours a day)
View or edit existing OSIsoft calls that you entered
View any of the calls entered by your organization or site, if enabled
See your licensed software and dates of your Service Reliance Program agreements

236
 Remote Access

From the OSIsoft Technical Support Web site, click Contact Us > Remote Support.
OSIsoft Support Engineers may remotely access your server in order to provide hands-on
troubleshooting and assistance. See the Remote Access page for details on the various
methods you can use.

On-Site Service

From the OSIsoft Technical Support Web site, click Contact Us > On-site Field Service
Visit.
OSIsoft provides on-site service for a fee. Visit our On-site Field Service Visit page for more
information.

Knowledge Center

From the OSIsoft Technical Support Web site, click Knowledge Center.
The Knowledge Center provides a searchable library of documentation and technical data, as
well as a special collection of resources for system managers. For these options, click
Knowledge Center on the Technical Support Web site.
The Search feature allows you to search Support Solutions, Bulletins, Support Pages,
Known Issues, Enhancements, and Documentation (including user manuals, release
notes, and white papers).
System Manager Resources include tools and instructions that help you manage archive
sizing, backup scripts, daily health checks, daylight saving time configuration, PI Server
security, PI System sizing and configuration, PI trusts for interface nodes, and more.

Upgrades

From the OSIsoft Technical Support Web site, click Contact Us > Obtaining Upgrades.
You are eligible to download or order any available version of a product for which you have
an active Service Reliance Program (SRP), formerly known as Tech Support Agreement
(TSA). To verify or change your SRP status, contact your Sales Representative or Technical
Support (http://techsupport.osisoft.com/) for assistance.

PI Manual Logger User Guide 237

Index
Internet Information Services, configure • 202, 204,
A 207
ActiveSync • 138, 173
L
Archive Values • 193
Audit Log • 118, 167, 188 Limit checks • 64
Auditing • 188
Auto Sync • 175 M
Maintenance • 191
B Menu Shortcuts • 40
Barcodes • 64, 67, 150, 159 Message logs • 120, 165, 189
data transfer • 188
C Global options • 43
Mobile devices • 121
CMDE (Conditional Manual Data Entry) • 215
barcodes • 150
Comments • 69, 70, 106, 169
clock synchronization • 174
Conditional Manual Data Entry (CMDE) • 215
configuring • 135
Configuration tools • 190
information on • 138
initializing • 135
D
setting up • 133
Data entry • 8 single-user mode • 183
from a mobile device • 8, 150, 153
from a PC • 8, 104, 107, 114 O
importing • 8, 116
Offline Work • 99
limit checks • 64, 82
Operator instructions • 78
options • 61
queued data • 194
P
scheduling • 72
sheet • 114 PI Manual Logger Introduction • 7
toolbar • 105 1.4 data, migrating to 2.0 • 195, 197
validation • 64, 82 installation • 11
Data Entry Group • 57, 185 menus • 38
Data transfer, from PC to mobile • 139, 173 starting • 37
Digital states • 93, 191 Web Services • 30
Windows Services • 27
F PI Manual Logger Mobile Introduction • 121
data entry • 153
Full Access Group • 57, 185
data transfer • 173
global settings • 147
G
menus • 146, 158
Global options • 43, 188, 191 message logs • 165, 167
PI Server
I auditing • 188
Installation, PI Manual Logger • 11 connections • 46
Installation, PI Manual Logger Mobile • 126 PI Trust • 186
Installation, SQL Server 2005 Express • 212 security • 187
Instructions, operator • 78
signing Tour Run edits • 168

PI Manual Logger User Guide 239

Index

starting • 144 searching • 66

tag history • 163 status • 115, 155
Tour Runs, working with • 152, 154 symbols • 115
Tours, working with • 151 Tag Groups • 87
view trends • 171 Tag List • 115, 156
trends, displaying • 96
Q Time delay • See Queued data
Queued data • 194 Timestamps • 63, 106, 107, 162
Tour Definition • 58, 59
S Tour Info pane • 58
Tour Migration Tool • 195
Scheduling data collection • 72 Tour Options • 61
Security • 181 Tour Run History • 117
PI Server Trust • 186 Tour Runs • 10, 101
settings • 43 Audit Log • 118
user database • 181 data entry • 104
user groups • 183 Data Entry Form • 107
Shortcuts, Menu • 40 Data Entry Sheet • 114
Signature on mobile devices • 168 downloading to mobile devices • 141
Signatures • 168 history • 117
Single-user mode • 183 importing • 116
SQL Server maintenance • 119
configuring SQL Server name • 25 reviewing • 116
detach database • 32, 34 Tours • 10, 55
Installing SQL Server 2005 Express • 211 comments • 69
Manual Logger Mobile, and • 133 creating • 57
SQL Server configuration • 18 data, migrating • 195
system requirements • 123 digital states • 93
Template Files, and • 19, 21 display trends • 96
Web Services, and • 30 downloading to mobile devices • 141
Windows Service, and • 27 group tags • 87
SYSTEM digital states • 93 limit checks • 64
System requirements • 13, 123 mobile device and • 151
Operator Instructions • 78
T options • 61
Tag Entry Options page • 81 scheduling • 78
Tag Groups • 87 trigger actions • 8
reordering • 91 work requests • 98
status • 115 Trends, displaying • 96, 171
Tag List • 115 Trigger Actions • 83
Tags
attributes • 78, 191 U
barcodes and • 67 Upgrade procedures • 231
cached values • 110 User accounts, managing • 181
configuration • 66 User groups • 183
format, setting • 81 User Options dialog box • 96
group tags • 87
history • 110, 163 W
operator instructions • 78
reordering • 91 Web Services • 135, 201
Windows Services • 27

240
Work Offline • 99
Work Requests • 98

PI Manual Logger User Guide 241