PI Manual Logger User Guide Version 2.0 4/14/2006

Transcription

1 PI Manual Logger User Guide Version 2.0 4/14/ OSIsoft, Inc. All rights reserved

2 OSIsoft, Inc. 777 Davis St., Suite 250 San Leandro, CA USA (01) (main phone) (01) (fax) (01) (support phone) Houston, TX Johnson City, TN Mayfield Heights, OH Phoenix, AZ Savannah, GA Seattle, WA Yardley, PA OSIsoft Australia Perth, Australia Auckland, New Zealand OSI Software GmbH Altenstadt, Germany OSI Software Asia Pte Ltd. Singapore OSIsoft Canada ULC Montreal, Canada OSIsoft, Inc. 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 Sales Outlets/Distributors Brazil Middle East/North Africa Republic of South Africa Russia/Central Asia South America/Caribbean Southeast Asia South Korea Taiwan OSIsoft, Inc. is the owner of the following trademarks and registered trademarks: PI System, PI ProcessBook, Sequencia, Sigmafine, grecipe, srecipe, and RLINK. All terms mentioned in this book that are known to be trademarks or service marks have been appropriately capitalized. Any trademark that appears in this book that is not owned by OSIsoft, Inc. is the property of its owner and use herein in no way indicates an endorsement, recommendation, or warranty of such party's products or any affiliation with such party of any kind. RESTRICTED RIGHTS LEGEND Use, duplication, or disclosure by the Government is subject to restrictions as set forth in subparagraph (c)(1)(ii) of the Rights in Technical Data and Computer Software clause at DFARS

3 Contents Chapter 1: Chapter 2: Chapter 3: Chapter 4: Introduction...1 Manual Data Entry...2 Other PI Manual Logger Features...3 What's New...5 Changes in the Server-Side Applications...5 Changes in the PC Client Applications...5 Changes in the Device Applications...6 Installation...9 System Requirements...9 Preparing Your System...10 Installing PI Manual Logger...12 Configuration...16 Getting Started...29 PI Manual Logger Terminology...29 Starting the PC Client...29 Global Options...31 PI Server Setup...33 Chapter 5: Working with Tours...35 Creating a Tour...36 The Tour Definition Dialog Box...38 Pattern-Matching in Tag Searches...57 Chapter 6: Working with Tour Runs...59 Importing Tour Run Data...61 Data Entry Dialog Box...61 Data Entry Toolbar...71 Reviewing a Tour Run...71 Viewing the History of a Tour Run...72 Tour Run Maintenance...73 PI Manual Logger User Guide Page i

4 Contents Chapter 7: Security and Auditing...75 Managing the User Database...75 PI Server Trust and Security...80 Auditing...81 Chapter 8: Using PI Manual Logger Mobile...83 Using Barcodes in Mobile Devices...83 Data Entry Methods...84 Getting Started...85 Tour List...97 Data Entry Screen...99 Data Transfer Appendix A: Message Logs PI Manual Logger Configuration Tool Appendix B: Web and Windows Services PI Manual Logger Web Services PI Manual Logger Windows Services Appendix C: Global Settings and Maintenance Updating Tags Attributes in the PI Manual Logger Database Archive Values Queued Data Appendix D: Tour Migration Migrating Tour Data What Is Migrated What Is Not Migrated Appendix E: Installing and Configuring SQL Server 2005 Express Edition System Requirements Installing SQL Server 2005 Express Edition Installing and Using SQL Server Management Studio Express Remote Connection to SQL Server Express Appendix F: Technical Support and Resources Before You Call or Write for Help Index Page ii

5 Chapter 1: Introduction PI Manual Logger is a set of client applications for manually entering data to the PI Server. Typically, a 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 -based Pocket PC device and uploaded to the PI Manual Logger PC application. Users can review and edit the data on the PC before sending it to the PI System. Imported data from an XML file. Users can review, edit, and validate the data in PI Manual Logger before sending it to the PI Server. A SQL Server is used to store configurations and other non-time-series-related data. PI Manual Logger User Guide Page 1

6 Introduction Manual Data Entry Using a PC as a Data Entry Station Using PI Manual Logger's built-in data entry screens, you can set up a PC as a data entry station. Lab data and plant log sheet data entries are typically handled in this way. You can use the data entry screens for data entry and review. 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. Using Mobile Devices with Optional Barcode Scanners With PI Manual Logger Mobile (page 83), you can collect data using mobile devices. Using the barcode feature, you can use scanning devices to identify tags and enter data. Data is time-stamped with the clock on the mobile device and transferred later to PI Manual Logger on a PC. Some reasons for using 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 you 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. For system hardware and software requirements, and supported devices, see System Requirements (page 9). Importing Data from Other Sources You can import data from files to PI Manual Logger, then review, edit, and validate it before sending it to the PI System. Page 2

7 Other PI Manual Logger Features Other PI Manual Logger Features Multi-user and Network Ready PI Manual Logger is a multi-user application and its data can be shared over a LAN. 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 sent to PI Manual Logger and optionally reviewed by a supervisor. 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 manual logs. Wired and Wireless Data Transfer PI Manual Logger supports both wired and wireless data transfer between a mobile device and the server. Data transfer can be initiated from either the PC or the mobile device. The transfer can synchronize the device time with the PI Server time and transfer data in both directions. PI Manual Logger User Guide Page 3

8

9 Chapter 2: What's New Changes in the Server-Side Applications PI Server version 3.4 or higher is required. Microsoft Internet Information Services (IIS) are required for PI Manual Logger Web Services access. PI Manual Logger Web Services can transfer data between the host server and clients, such as Windows Mobile devices. Microsoft SQL Server (version 2000 or 2005) is the primary data store for all structured data (except process data are sent to the PI Server). Changes in the PC Client Applications PI Manual Logger is now Microsoft.NET-based to improve its functionality and reliability. Access 97 runtime is no longer used to store and transfer intermediate data. Data is stored in a central PI Server and Microsoft SQL Server database. To simplify security management, there are now only two user permission levels: administrative and data entry. Hierarchical view and organization of Tag Groups are supported. Importing existing hierarchical structures from PI Module Database is now supported. Ad hoc trends are available on the Tour Definition and Data Entry dialog boxes. Users can delete existing PI tag values instantly. Users can add comments to existing PI tag values instantly. Tag collection specifications, Tag Group status, and comment tags now work with the hierarchical view of Tag Groups. PI Manual Logger User Guide Page 5

10 What's New The Tour Scheduling Overview dialog box shows all schedules specified for tags, Tag Groups, and the whole Tour in a single dialog box. In addition to Tag and Tag Group comments, PI Manual Logger now supports Tour-level comments. Comment templates expedite the entering of commonly used comments. Users can import data from PI Reason Codes and the reason tree into comment templates. Users can add instant (ad hoc) comments to Tag values, Tag Groups, and Tours, regardless of whether a comment tag is configured. Users can configure comments to be stored in both the annotation and the comment tag. Advanced message and activity logging records messages and user activities into the PI message log for auditing purposes. In addition to automatic logging, users can manually add entries to the message log. Manual log entries can also use comment templates. Users can configure Tour Run changes to be audited in the Tour Run audit trail. Each tour run save is logged in the tour run history for later auditing. A Windows Services agent is included to keep the data between the SQL database and the targeting PI Server up-to-date. An application configuration tool is included to expedite the configurations for database connection, view logs, and rapid access to the PI Manual Logger Windows Services. The Tour Migration Tool allows users to migrate PI Manual Logger 1.4.x Tour definitions to the new SQL Server-based database. Changes in the Device Applications The product name is now PI Manual Logger Mobile to reflect supported mobile operating system platforms. PI Manual Logger Mobile is Microsoft.NET-based to improve the functionality and reliability of the application and database. PI Manual Logger Mobile supports Windows Mobile for Pocket PC 2003 and later versions. The startup dialog box shows the Tour and Tour Run list after the use database is initialized and the user is authenticated. PI Manual Logger Mobile supports single-user and single-tour modes to expedite data entry on mobile devices. Page 6

11 Changes in the Device Applications User names and passwords in PI Manual Logger Mobile are identical to those used in the PI Manual Logger Windows application. To simplify security management, there are now only two user permission levels: Tour administrative and Tour data entry. Data on the device side is stored in a high performance, more reliable mobile database, Microsoft SQL Mobile 3.0. The database can be stored on a non-volatile memory card to prevent data loss from battery loss and other hardware failures. PI Manual Logger Mobile is more scalable: The new high-performance mobile database allows a larger number of Tours and tags on the device. Important messages and user activities can be logged on the device and saved in the PI message log for auditing purposes. In addition to automatic logging, users can also manually add log message entries. Hierarchical view and organization of Tag Groups are now supported. Users can display Tag Group status--such as due status, limit violations, and empty tags. Tag collection specifications, Tag Group status, and comment tags now work with the hierarchical view of Tag Groups. In addition to tag and Tag Group comments, PI Manual Logger Mobile now supports Tour-level comments. Comment templates are added to expedite entering of commonly used comments. The manual log entries can also use comment templates. Users can add instant (ad hoc) comments to tag values, Tag Groups, and whole Tours, regardless of whether a comment tag is configured. Users can configure comments to be stored in both the annotation and the comment tag. Users can configure Tour changes to be audited in the Tour Run audit trail. Each tour run save is logged in the tour run history for later auditing. Users can store enter and store handwritten signatures with the Tour Run. Web services now supports wireless data synchronization and transfer (such as sending completed Tour Run data to the remote PI Server/SQL Server and getting updated Tour definitions, tag attributes, and global settings). An improved, asynchronous, AutoSync module handles routine synchronizing tasks. A more efficient comment entry screen includes historical values, tracking audit changes, and user logs. The Device Status window shows the current device status, such as remaining memory and battery life. PI Manual Logger User Guide Page 7

12 What's New The device initialization and management procedures are simplified. All data transfer and device initialization tasks can be performed from the PC side, without switching between device and PC. Once the device database is initialized from a PC, data transfers can be initiated from either PC or device independently. The device can initiate data transfer if it is connected to the network, either through wired or wireless connection. PI Manual Logger Mobile supports barcode scanning on some symbol barcode-scanning Windows Mobile devices. Page 8

13 Chapter 3: Installation System Requirements Servers Minimum Software Requirements: PI Server version or higher Internet Information Services (IIS version 5.0 or higher) for Web service support. The Web server does not have to be installed on the same server where PI Server is installed. Microsoft SQL Server 2005 or Microsoft SQL Server 2000 (Service Pack 3 or later) PC Client Minimum Software Requirements: One of the following Windows systems: Windows 2000 Professional Service Pack 4 Windows XP Professional Service Pack 1 or higher Windows 2000 Server Windows 2003 Server If you are using PI Manual Logger Mobile, ActiveSync 4.0 build 4343 or higher PI SDK build 304 or higher Minimum Hardware Requirements: 256 MB RAM 256 color display PI Manual Logger User Guide Page 9

14 Installation 1024 x 768 screen resolution Network connection Mobile Devices Software Requirements: Windows Mobile 2003-based Pocket PCs or above (Pocket PC 2003 or above). Note: Pocket PC 2002 and older devices are not supported in this version. Windows Mobile 5.0 devices ActiveSync 4.0 build 4343 or higher Minimum Hardware Requirements: 58 MB available RAM memory on the device USB or Serial connection to a PC Workstation Recommended: Flash memory cards CompactFlash (CF) or Secure Digital (SD) to store PI Manual Logger Mobile database Barcode scanner Wireless connection Note: PI Manual Logger does not support Palm OS-based devices and Symbian-OS based devices, such as some Nokia cell phones and mobile devices. Preparing Your System Install IIS Server See the Windows help and administrator's guide for details on installing and configuring IIS. Page 10

15 Preparing Your System Install SQL Server See the SQL Server help and manual for details on installing SQL Server. Note: PI Manual Logger supports both SQL Server 2000 and SQL Server You can also use SQL Server 2005 Express Edition with PI Manual Logger. Back Up 1.4.x Tour Definitions If you are currently using PI Manual Logger 1.4.x and want to upgrade to the newer version, back up your existing 1.4.x Tour definitions database. The 1.4.x Tour definition database is a Microsoft Access 97 database file, which by default is named pimls135.mdb. To check the location of your current PI Manual Logger 1.4.x database, launch PI Manual Logger 1.4.x and choose PIML > Administration > Attach to another PIML Data file. Once you know the location of your database file, you can save the database file to a backup storage location (such as a separate backup server, a network share, or a different folder on your PC workstation). The Tour definition backups can later be upgraded to the new version and the new data store using the PI Manual Logger Tour Migration tool. For details on database migration, see Tour Migration (page 127). Note: Not all information in Tour definitions is migrated into the new database format. For details, see What is Not Migrated (page 129). PI Manual Logger User Guide Page 11

16 Installation Installing Microsoft ActiveSync If you plan to use Windows Mobile devices to manually collect data with PI Manual Logger Mobile, install Microsoft ActiveSync before installing the mobile applications onto the devices. This version of PI Manual Logger requires ActiveSync 4.0 build 4343 or later. To get the latest version of ActiveSync, check the system requirements for ActiveSync installation. Contact Microsoft for details. Caution: ActiveSync 4.0 or later versions are not compatible with PI Manual Logger 1.x versions. Do not install ActiveSync 4.0 on workstations that still need to run PI Manual Logger 1.x (such as version 1.4). Device Preparation Perform a hard reset on the device and clear all residue memory before installing PI Manual Logger Mobile. Tip: If you have previous versions of PI Manual Logger installed on the device, transfer your existing Tour Run data onto the PC host and then do a hard reset on the device to erase all installed software and data prior to installation of the new version. Installing PI Manual Logger Server-Side Installation To install PI Manual Logger on a server, use the same setup kit as the PI Manual Logger client installation and choose the server features, such as Windows Service and Web Services, to install on the server. Note: If Microsoft.NET Framework 2.0 is not installed, the PI Manual Logger setup kit installs it, as well as Microsoft ASP.NET 2.0. If you plan to use PI Manual Logger Web Services, register ASP.NET with your IIS Web server before using the Web Services. In a command prompt, navigate to \Windows\Microsoft.NET\Framework\v (the exact version number may vary) and enter: aspnet_regiis.exe -i Page 12

17 Installing PI Manual Logger PC Client Installation Launch the client installation kit to install PI Manual Logger client applications. You can install all of the features or just the features you need. Note: If you choose to install the Database Files feature, a blank SQL database file is included in the installation. You can later copy and attach the blank database file to your SQL Server and point PI Manual Logger clients to the attached database. For details on configuring the database location for PI Manual Logger clients, see Configuration (page 16). Both SQL 2000 and SQL 2005 template database files are included. Mobile Device Application Installation Use ActiveSync 4.0 build 4343 or higher and either work as a Guest or set up a partnership between the mobile device and the PC running PI Manual Logger. All connection settings allowed by ActiveSync, such as serial, USB, infrared, and Bluetooth, are supported. PI Manual Logger User Guide Page 13

18 Installation Notes: For details on mobile device initialization, see Mobile Database Initialization (page 88). If you work as a Guest, ActiveSync does not synchronize the mobile device and the PC clocks. To install the device applications from the PC: 1. Launch the PimlMobileSetup kit. 2. Follow the instructions in the setup kit. 3. Once you choose where to install device CAB files, the Microsoft.NET Compact Framework 2.0 and Microsoft SQL Server Mobile 3.0 installers launch. Always click Yes to install the runtime files (Microsoft.NET CF 2.0 and SQL Mobile 3.0) in the default location. 4. 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- Page 14

19 Installing PI Manual Logger volatile memory card, such as built-in flash ROM, CompactFlash (CF) and Security Digital (SD) cards. If you install the application somewhere other than the default location, you may save some device main memory (RAM) that can be used later for PI Manual Logger. Notes: Even if you install PI Manual Logger Mobile in a non-volatile memory location, you must completely re-install the.net Compact Framework and SQL Mobile 3.0 runtime in case of battery loss. This is because some required runtime files are always installed in the \Windows RAM folder, regardless of which location you choose during installation. For Windows Mobile 5.0 devices, the ActiveSync installation destination dialog boxes appear on the device instead of on the PC. PI Manual Logger User Guide Page 15

20 Installation Configuration Server-Side Configuration Use the Computer Management interface (MMC) to configure the PI Manual Logger Web Services (page 119) security settings. Page 16

21 Configuration Note: If you are running the PI Server on a Windows XP SP2 system, make sure the PI port (TCP/IP 5450) opens through the Windows Firewall Control Panel. SQL Server Configuration SQL Server 2005 PI Manual Logger stores all data that is not related to process data in a SQL Server database. A blank database file is included in the server-side installation. You can ask your database administrator to move the database file to a more secure location and attach to the designated SQL 2005 database server. Once you attach the database file to the server, follow the configuration section on the clients to configure the correct connection string before using PI Manual Logger PC clients. If you selected Database Files during installation, all template database files are installed. These include template files for both SQL Server 2005 and SQL Server Files ending with 2000 are for SQL Server 2000, and those that do not end with 2000 postfix are templates for SQL Server PI Manual Logger User Guide Page 17

22 Installation You can use the SQL Server 2005 Management Studio to manage databases in the database server. If PI Manual Logger Web Services is set up, configure the security so that users have write and read data access to the PimlWindows database. Page 18

23 Configuration For Web Services access, create your own SQL Server user account and assign this user full data and data schema access to the PimlWindows SQL database. For details on users and database roles, see the SQL Server 2005 documentation. PI Manual Logger User Guide Page 19

24 Installation SQL Server 2000 You can also use Microsoft SQL Server 2000 as the back-end database engine for PI Manual Logger. To do so, attach the included template database file for SQL Server The files are marked as PimlWindows2000.MDF. If PI Manual Logger Web Services is set up, configure the security so that users have write and read data access to the PimlWindows database. You can either grant the default ASP.NET user (Computer\ASPNET) full data and data schema access to the PimlWindows database, or create your own SQL Server login user account and assign full data and data schema permissions to the PimlWindows database for this user account. Page 20

25 Configuration For details on users and database roles, see the SQL Server 2000 documentation. PI Manual Logger User Guide Page 21

26 Installation Windows Services Configuration Configure PI Manual Logger Windows Services (page 120) using the Windows Computer Management utility. Use the Windows Computer Management utility to specify the security context for the services to run. By default, the service runs under System account. Page 22

27 Configuration Note: If you are using a local system account for the Windows Services, make sure the user has proper data access permissions to the SQL Server database. For best results, use a dedicated Windows domain account instead of a local system account to run the Windows Services. Configuring PI Manual Logger Web Services If you selected the Web Services feature during installation, the Web Services applications and configuration tools are installed in the pipc\pimlwebservices folder. Before using PI Manual Logger Web Services to transfer data between clients and the host server, configure the service settings. The service setting file PimlCommonSettings.xml is in the folder pipc\pimlwebservices. To configure PI Manual Logger Web Services, use the graphical configuration tool (PimlTools.exe in the folder pipc\pimlwebservices) or edit the XML file directly. Run the configuration tool to set up the proper SQL connection to the targeting SQL server. PI Manual Logger User Guide Page 23

28 Installation Note: Integrated Windows security in connection to SQL server is not recommended since it must grant all ASP.NET Web applications full access to the PimlWindows SQL database. Instead, use a specific SQL user account created by your SQL Server administrator. PC Client Configuration PI Trust To initialize trust table settings and set up the default PI Server connection from the PC client, use the PI Trust Editor plug-in available in PI SMT 3. Using the PI Trust Editor, map your PC client and Windows users to existing PI users on the PI Server. For details on PI Trust and PI Trust Editor, see the related PI Administrators Guides. Page 24

29 Configuration You can also choose File > Connections from PI System Management Tools (version 3 or higher) to launch the PI Connection Manager dialog box. In this dialog box, choose Edit > Settings, then click Advanced to configure the default PI Server connection from the PI client. For details, see the PI System Management Tools online help. Configuration Tools After installation, use the PI Manual Logger Configuration Tools to configure the database connections, view system information, and manually start or stop PI Manual Logger Windows Services. To access the PI Manual Logger Configuration Tools dialog box, choose Start > Program Files > PI System > PI Manual Logger > PIML Configuration. PI Manual Logger User Guide Page 25

30 Installation In the Database Connection Setup dialog box, after entering SQL Server connection information, click Test to make sure you can successfully connect to the targeting SQL server database. Note: For PC client applications, you can specify the connection security to integrate with Windows Domain account security or use a specific SQL user account for the PC client application. If you use a specific SQL user account, check with your SQL Server administrators to make sure the account has proper privileges to the PimlWindows database. If you are using integrated Windows/SQL server security, choose Use my Windows credentials. If you are using SQL Server 2005 Express edition, the data source is ServerName\SQLExpress. Configuring ActiveSync Before you can download data to or upload data from a mobile device, set up ActiveSync for file transfers between device and PC. In ActiveSync, choose File > Connection Settings to specify the correct COM port to use for file transfers. Note: No partnership between the mobile device and the PC is required for data communication. Page 26

31 Configuration To avoid the partnership synchronization process each time you dock the mobile device, enable Guest mode. PI Manual Logger User Guide Page 27

32

33 Chapter 4: Getting Started PI Manual Logger Terminology Tour Tour Run A list of PI tags grouped together in order to facilitate data collection. A set of values, statuses, comments, and associated timestamps taken for tags in a Tour. Starting the PC Client To start PI Manual Logger, choose Start > Programs > PI System >PI Manual Logger > PI Manual Logger. The Login dialog box appears. 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. See User Database Management (page 75) for details on users and permissions management. 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 workstation 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, 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. PI Manual Logger User Guide Page 29

34 Getting Started Main Menus Use the File menu to manage the user database, maintain cached PI data, change your user password, and exit the application. Use the Tours menu to create and manage Tours and Tour Runs, 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, and download the user database from PI to a mobile device. Use the Tools menu to set up user preferences, maintain Tours, and perform administrative tasks. Use the Help menu to access the PI Manual Logger help system and view system information. Page 30

35 Global Options About Dialog Box The About dialog box shows the system and run-time information, and the versions of the operating system, PI Manual Logger, and Microsoft.NET platform. To access this dialog box, choose Help > About. Tip: You can right-click inside the text box to copy the information text to the Windows clipboard and paste it into any word processor or window. 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 page, you can specify the number of Tag values that PI Manual Logger caches. PI Manual Logger User Guide Page 31

36 Getting Started On the Message Logging page, you can specify the type of events that the system enters in the PI Manual Logger logs. On the Security Settings page, you can 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. Page 32

37 PI Server Setup 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. PI Server Setup 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 that affect all PI Manual Logger user sessions. To do this, choose Tools > PI Server Setup. Click Advanced to launch the PI Connection Manager dialog box. This dialog box lets you add and remove PI Servers in your PI Server table. PI Manual Logger User Guide Page 33

38 Getting Started The changes you make to the targeting PI Server affects all PI Manual Logger Clients and PI Manual Logger user sessions. These settings are stored in the central PI Manual Logger SQL Server database. Page 34

39 Chapter 5: Working with 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. From the Tour List, you can create, modify, and delete Tours. The Select a Tour dialog box lists available Tours from the PI Manual Logger database. To edit Tours, you must have Create/Edit Tour permissions for the Tour. Otherwise, the Tour definition opens in read-only mode. PI Manual Logger User Guide Page 35

40 Working with Tours The Tour List toolbar options are: Tool Description Toggle the Search Options pane on and off. In the Search Options pane, you can use pattern matching (page 57) in the Filter By box. Create a new Tour. Delete the selected Tour. If you click Yes at the prompt, PI Manual Logger deletes all tags 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 Definition dialog box. Save a copy of the selected Tour. This is useful when you want to build a Tour from a pre-defined template. Close the Tour List. Creating a Tour You must have at least Create/Edit Tour permissions to create a Tour. To create a new Tour, click. Page 36

41 Creating a Tour The boxes in the New Tour dialog box are: Tour Name: Blank or duplicate Tour names are not permitted. Description: A Tour description is optional. Full Access Group: A group that can access the Tour 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 on users and permission groups, see Managing the User Database (page 75). 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 a new tour and launch the Tour Definition dialog box. PI Manual Logger User Guide Page 37

42 Working with Tours The Tour Definition Dialog Box You can close the Tour Info pane, and close or change the width of the Tag Attributes and Tag Attributes panes. To re-display these panes, choose them from the View menu. The Tour Info Pane In the Tour Info pane, users can view and manage Tour information, including the Tour name and description, user permission groups (page 79), comments (page 49), schedules, and notes. Page 38

43 The Tour Definition Dialog Box Data Collection Scheduling To define conditional data collection scheduling: 1. Choose a Tour from the Tour List. 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 page, click the Set button next to the Collection Scheduling box. For a Tag Group: On the Tag Configuration page, click the Set button next to the Collection Scheduling box. For a Tour: In the Tour Info pane, click the Set button next to the Tour Scheduling box. In a typical data collection process, you may have some tags for which data are collected every hour, and others for only 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 Scheduling Specification dialog box, choose Daily or Weekly. 4. Click Set Depending on the scheduling type you chose, either the Daily Collection Schedules or Weekly Collection Schedules dialog box appears. PI Manual Logger User Guide Page 39

44 Working with Tours 5. Set the start time and frequency and click OK. 6. To save your changes to the Tour, click. Tour Scheduling Overview The Tour Scheduling Overview dialog box shows all the defined Tour, Tag Group, and Tag schedules in the selected Tour. You can view, modify, delete the schedules. To access the Tour Scheduling Overview dialog box, choose > Schedule Overview. Page 40

45 The Tour Definition Dialog Box Tour Options Use the Tour Options dialog box to control a Tour's edit options during data entry. To access this dialog box, click Tour Options in the Tour Info pane. PI Manual Logger User Guide Page 41

46 Working with Tours General Tour Options Warn if the Tour Run is incomplete When enabled, if users close an incomplete Tour Run, PI Manual Logger issues a warning. Default current comment to last entered comments When enabled, the comments for the current Tag value default to the last available comment for the Tag saved in the PI Server. Manual data must be submitted for approval When enabled, users in the data entry group can submit manual data for later approval before they are sent to the PI Server. Auto Send Data to PI When enabled, manually entered data is 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. Data Entry Only Group can send data to PI When enabled, users in the Data Entry Group can collect and submit data for review, but cannot send the collected data to PI tags. Only users in the Full Access Group can review and send the data to the PI Server. For details on setting Tour Group permissions, see Associating a Tour with a Permission Group (page 79). Note: If the Data Entry Only group and Full Access group are identical, this option is not available. Default current tag value to last entered value When enabled, the current Tag value defaults to the last available value for the Tag saved in the PI Server. Prompt me for any unarchived values When enabled, PI Manual Logger prompts users to send any unarchived data to the PI Server (if they have permission to do so). Prompt before sending to PI When enabled, PI Manual Logger prompts users for confirmation before sending data to the PI Server. Overwrite existing PI data instead of insert duplicates When enabled, PI Manual Logger overwrites existing PI data with the same timestamp. If disabled, PI Manual Logger inserts the new value with the same timestamp. Auto Prompt for Digital State (affects mobile devices only) When enabled, if a digital Tag is presented for data entry, a list of the digital states for the Tag appears for selection. Page 42

47 The Tour Definition Dialog Box Write comments to both annotation and comment tag (if configured) When enabled, PI Manual Logger records comments in the annotation and comment tag, if the comment tag is configured. For details, see Comments (page 49). Signature required for each tour run save (on mobile device) When enabled, users entering data in mobile devices must use a handwritten signature when closing and saving a Tour Run. Handwritten signatures then appear in the Tour Run History dialog box once they are transferred onto the master SQL database. Display confirmation after sending to PI When enabled, PI Manual Logger prompts users with a confirmation dialog box showing the number of tags that were sent to the PI Server. Timestamp Tour Options Default Tour Time to the Current Timestamp When enabled, PI Manual Logger uses the current time as the timestamp. When disabled, PI Manual Logger's timestamp defaults to the whole hour. Allow Tour timestamp to be edited When enabled, users can edit the Tour's timestamp. Tag timestamp should always default to Tour timestamp When enabled, the timestamp for each data point uses 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. Allow Tag timestamp to be edited When enabled, the timestamp for each data point can be edited. Limit Check Tour Options Use the Limit Checks Tour Options page to set how limit checking appears to the data entry user for the current Tour. When a limit violation occurs, the visual indication is a color change to the value and background. For details on using limit checking for data validation, see Setting Data Validation Limits (page 53). Note: Regardless of what limit checking levels are selected in the dialog box, limit violation is always recorded in the auditing and message log system in PI Manual Logger. PI Manual Logger User Guide Page 43

48 Working with Tours Barcode Tour Options Barcode, if assigned, must be scanned or manually entered before data entry is allowed (affects mobile devices) When enabled, for any tag or Tag Group that has a barcode association (page 48), users must scan or enter a barcode before they can access the Data Entry screen. Display barcode enter screen before data entry screen (affects mobile devices) The initial screen on the mobile device when starting a new Tour is the scan barcode scan screen. 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. Notes: If the date/time box for a tag is left blank, it defaults to the Tour date/time. This option may be useful when entering 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. For a fully barcode-based system, where tags are aliased with barcodes, a single Tour may be set up including all tags for which data are to be collected and data entered without following the sequence in which tags are configured in the Tour. Other Tour Options On the Other page, specify the format for data that is in number.number.number format. For example, if Feet.Inch.sixteenth is chosen, then the entry means 12 feet, 5 inches, and 8 sixteenths of an inch. This entry results in a final value of: 12 + (5 + 8/16)/12 = 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 Tour Definition Toolbar The following functions are available from the Tour Definition dialog box's toolbar: Page 44

49 The Tour Definition Dialog Box 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 a new tag Remove the selected tag Show Digital States Reorder tags Save the Tour Close the Tour (be sure to save your changes before closing) Display or hide panes. Click this button and select or de-select a pane. Tag Configuration Page Selecting Tags You can include a tag only once in a Tour, but you can have the same tag in more than one Tour. Multiple values for a tag during data entry are allowed. To select the tags that will be collected manually: 1. In the Tour Definition dialog box, make sure the Tag Configuration tab is selected. 2. Click or click Set... next to the Tag Name box. The Tag Search dialog box appears. PI Manual Logger User Guide Page 45

50 Working with Tours 3. Perform a search and select one or more tags. For details on pattern-matching, see Pattern-Matching in Tag Searches (page 57). Note: Your PI Manual Logger user account must have both read/write data access and read/write point access to the selected tags in order to add them to the Tour. Otherwise, the Add Tags process fails. For details, see User Database Management (page 75). Displaying Ad Hoc Trends To display a tag's ad hoc live trend, click tag and choose Show Trend., or in the Tag List View pane, right-click the Page 46

51 The Tour Definition Dialog Box In PI Manual Logger trends you can show annotations and events, and scroll through time ranges. Note: To change the default time span for trends, choose Tools > Preferences and set the time span in the User Options dialog box. PI Manual Logger User Guide Page 47

52 Working with Tours Using Barcodes with Tags and Tag Groups When using a mobile device that 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. During data entry on a PC, if you use the Tag Group view, the tags are grouped by the selected Tag Group. 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 the Release Notes. 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 have 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, and 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. Page 48

53 The Tour Definition Dialog Box There is no limit to the number of groups or the number of tags within a group. For details on configuring behavior for barcodes, see Barcode Tour Options (page 44). For details on using barcodes with mobile devices, see Using Barcodes in Mobile Devices (page 83). Comments Comment Types You can enter comments for the tag value being collected, a Tag Group, or the whole Tour. You can use comments to capture operator comments as part of the manual data collection. 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. Note: Even if you don't configure any comment tags for a process value tag, users can still enter ad hoc text comments for a value. The ad hoc comments are stored in PI Annotations associated with the entered value. If you configured 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. A comment has the same timestamp as the process value tag. Once the comments and values are sent to the targeting 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. Comment Templates You can pre-define comments, which users can then use during data entry. Pre-defined comments are called comment templates. To view or modify the list of pre-defined comment templates, choose Tools > Comment Templates. PI Manual Logger User Guide Page 49

54 Working with Tours 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. Once you select a node in the reason tree, the node imports as the template name, and all its direct sub-nodes import as template entries. Page 50

55 The Tour Definition Dialog Box The PI Reason Tree can be shared among multiple PI applications. You can edit it in PI SMT version or later: PI Reason Tree editor in PI SMT 3 Tag Groups Tag Groups let you 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 view the Tag Group List for the current Tour, click Set next to the Tag Group box. The Tag Group Editor dialog box appears. You can 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 the barcode button, 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 Page 51

56 Working with Tours To import Tag Group hierarchy from an existing PI Module Database: 1. In the Tour Definition dialog box Tag List View pane, right-click in the Tree View tab and choose 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. Page 52

57 The Tour Definition Dialog Box Operator Instructions Use the Operator Instructions box 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: Enter tag timestamp. 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. Setting Tag Formats On the Tag Entry Options page in the Tag Entry Preformat box, you can 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 for that tag, then the final value for that tag is 12, Setting Data Validation Limits You can produce warning messages during data entry using Data Validation limits. Set the limits according to your own preferences. PI Manual Logger User Guide Page 53

58 Working with Tours You can 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 next to the box of the limit you want to set, then select a tag from the Tag Search dialog box. 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. By default, the Limit checks are enabled. For details on configuring limit checking behavior, see Limit Check Tour Options (page 43). SYSTEM Digital States You can select SYSTEM states in the SYSTEM State set, which are associated with all the tags in a Tour. For example, Meter Broken, Bad Data, Idle, Out of Service, Not Running, Equipment Off, and Tagged Out. To access SYSTEM States, click. The Tour System States dialog box appears. Page 54

59 The Tour Definition Dialog Box You can associate digital strings for real and integer tags. For example, imagine 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 of the states you want to add, rightclick, and choose Add Selected. To hide digital states from the available digital states list, select the states you want to hide, right-click, and choose Hide Selected. To show all available digital states, right-click in the Available States pane and choose Show All. Reordering Tags and Tag Groups The tag sequence defines the order in which data are to be collected in a Tour, especially when a mobile device is used. To rearrange the order of tags in the Tour, click the reorder button. PI Manual Logger User Guide Page 55

60 Working with Tours You can also drag-and-drop tags and Tag Groups in the Tag List View pane, Tree View tab. When you have completed the definition for a tag, click Add to add another tag or click Save to save the Tour definition. Page 56

61 Pattern-Matching in Tag Searches Pattern-Matching in Tag Searches Built-in pattern-matching provides a versatile tool for string comparisons. The patternmatching features allow you to match each character in a string against a specific character, wildcard character, character list, or character range. The characters allowed in a pattern are: Characters in pattern Matches in string? Any single character * Zero or more characters # Any single digit (0-9) [ charlist ] Any single character in charlist [! charlist ] Any single character not in charlist PI Manual Logger User Guide Page 57

62

63 Chapter 6: Working with Tour Runs In PI Manual Logger, a Tour Run is a set of values, statuses, comments, and associated timestamps taken for tags in a Tour. To show Tour Runs: 1. Choose Tours > Tour Run List. The Select a Tour Run dialog box appears. 2. In the Tour List (top pane), select the Tour you want. 3. The Tour Runs appear in the Tour Run List (bottom pane). If any unapproved data was previously entered for a Tour, the timestamp and responsible operator names appear in the bottom section. The Tour Run List columns are: PI Manual Logger User Guide Page 59

64 Working with Tour Runs Tour Name Run Time Stamp Operator 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 PI. Empty Tags Tip: 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 PIMLADMIN privileges, you can select all Tours. For details on user permissions and groups, see User Groups (page 77). The Tour Run tools are: Tool Description Toggle the Search Options pane on and off. In the Search Options pane, you can use pattern matching (page 57) in the Tour List Filter By box. 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 63). Note: If the Tour Run is archived, you can view the information, but you cannot change or update it. 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. Send data from the selected Tour Run to the PI Server. Open the selected Tour Run so you can modify or add values. For details, see Data Entry Form (page 63). Close the Tour List. Page 60

65 Importing Tour Run Data Importing Tour Run Data To import Tour Run data from external files: 1. In the Select 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 Mobile database file (.SDF). The PI Manual Logger installation folder includes a sample of the XML dataset. The XML dataset includes the following tables: tbltourrun tbltourruntag tbltourruntaggroup tbltourrunauditlog For importing from the SQL Server Mobile database file (.SDF), the files can be from devices and Tablet PCs running PI Manual Logger Mobile. Data Entry Dialog Box 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. Note: You must have at least Data Entry permission level to enter and edit tag values and timestamps. PI Manual Logger User Guide Page 61

66 Working with Tour Runs Tour Run Info Pane The Tour Run Info pane contains the following boxes: Tour Name Tour Description Workstation or Device ID: The PC Workstation or Mobile Device identifier. This box is used to uniquely identify a mobile device, when PI Manual Logger Mobile is also used to collect data using mobile devices. User Name: This need not be the same as the PI Manual Logger login or the PI user name. This box may be left blank. Tour Run Time Stamp: A valid PI Time (the timestamp format conforming to the system time format). To enter the current time, click. Page 62

67 Data Entry Dialog Box Tour Comment: Enter a comment, or click dialog box. to open the Comment/Log Entry 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. Data Entry Form Use the Data Entry Form page to enter, edit, and timestamp tag values. Note: To perform these tasks, users must belong to the Data Entry Group. See Associating a Tour with a User Group (page 79) for details on specifying user groups. You must have Send to PI permission level (specified in General Tour Options (page 42)) to write values to the PI Server. PI Manual Logger User Guide Page 63

68 Working with Tour Runs 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). If SYSTEM digital states are configured for the Tour, you can select a state for the tag or Tag Group from the drop-down list. To display an instant (ad hoc) trend for the tag, click. The PI Manual Logger Trending dialog box displays the tag's live trend. You can scroll the trend through different time ranges. Page 64

69 Data Entry Dialog Box Value Comment: A comment associated with the tag. If you are using templates, you can pick pre-configured comments from the template and add them to the comment text entry. You can add multiple comments from the template. Tag Timestamp: A valid PI time. Click the Clock icon to insert the current time. Using an asterisk (*) to indicate the current time 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. Data Entry Sheet In the Data Entry Sheet page, you can right-click the data rows to save and revert changes, submit data you have entered for approval, and, if the Tour states are configured, set the tag status. Audit Log The Audit Log page shows any changes that have been made to the manual data since the creation of the Tour Run. PI Manual Logger User Guide Page 65

70 Working with Tour Runs Note: If you delete a Tour Run, you also delete its Audit Log from the PI Manual Logger database. If you re-send any changed data to the PI Server, however, the changes are audited by the PI audit trail instead of the PI Manual Logger Tour Run audit trail. 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. Page 66

71 Data Entry Dialog Box To use a previous value, comment, or both as the input for a tag, select the tag you want, right-click, then select the option you want. To show a trend for a tag, select the tag you want, right-click and choose Show Trend. To show the details for tag, select the tag you want, right-click, and choose Show Details on this value. The Tag Value Details dialog box 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. To add a comment to a tag value, select the tag value you want, right-click, and choose Add Comment. Enter your comment in the comment 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 Page 67

72 Working with Tour Runs To delete a value from the PI server, select the value you want to delete, right-click it, and choose Delete Selected Value from PI. Note: If you do not have permissions to delete the selected values from PI, this menu item is unavailable. If multiple values have the same time stamp, only the first tag value is deleted. To change the search range of the displayed historical values for the current tag, rightclick and choose Search Criteria. The Search Previous Values dialog box appears. Page 68

73 Data Entry Dialog Box If you select Time-based search: 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 value in the past 24 hours appears. If you select Number of Values, 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 number, even though there may be more values in the specified Start and End time range. By default, values from the PI Server Archive are displayed in reverse chronological order, with the most recent appearing at the top. To change the display order, click the appropriate column header. Message Log Viewer You can access the message log in the Data Entry dialog box to expedite log entries. To launch the Message Logs pane, choose > Message Log. Right-click in the Message Logs pane to refresh the display, add a new log entry via the Comment/Log Entry dialog box, or copy the entire log onto Windows clipboard so you can paste the text into another application. PI Manual Logger User Guide Page 69

74 Working with Tour Runs Tag List Pane In the Tag List pane, the symbols associated with tags and Tag Groups are: 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 or Tag Group is due for data collection and already has 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, choose Set Status, and select a status from the drop-down list. Page 70

75 Data Entry Toolbar Data Entry Toolbar The following functions are available from the Data Entry dialog box's toolbar: Tool Description Go to the next or previous limit violation Move to the first tag in the sequence that is due for collection Note: The navigation buttons only go to tags that are due for collection and do not yet have entered data. If you want to view any tag regardless of its status, use the Tag List pane, List View page. 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. Submit the completed Tour Run for supervisor's approval Approve the submitted Tour Run data and send the approved data to PI Save the Tour Run Close the Tour Run Display or hide panes Reviewing 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. PI Manual Logger User Guide Page 71

76 Working with Tour Runs To review Tour Run data: 1. Choose Tours > Tour Run List. 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: Once you send reviewed data to the PI Server, the data is stored in the cached database. We recommend that you use any PI client tools to retrieve tag values, comments, and other auditing information from the PI Server. Viewing 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. Choose Tours > Tour Run List. 2. Select the Tour and Tour Run whose history you want to view. 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. Page 72

77 Tour Run Maintenance Tour Run Maintenance To manage unapproved Tour Run data stored in the database, choose 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. Note: Only users that are members of the pimladmin permission group can access this function. PI Manual Logger User Guide Page 73

78 Working with Tour Runs Note: Approved Tour Run data is saved in the targeting PI tags. We recommend that you use corresponding PI client tools (such as PI ProcessBook and PI DataLink) to view the approved data available. Page 74

79 Chapter 7: Security and Auditing Managing the User Database PI Manual Logger includes a separate user database, which is shared by the desktop applications, the PI Manual Logger Web Services (page 119) 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 Management dialog box, choose File > Manage User Database. You must be a member of the administrative user group to access this feature. PI Manual Logger User Guide Page 75

80 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. 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: Page 76

81 Managing the User Database 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. Note: If Log user group membership changes is enabled in Tools > Global Options > Message Logging, PI Manual Logger records all changes made to the user database in the message logs. Note: If you are a member of the administrative group, you don't need to know a user's current 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 Configuring a Mobile Device (page 86). User Groups Once PI Manual Logger is installed, it creates the default user group pimladmins. By default, this is the administrative group. PI Manual Logger User Guide Page 77

82 Security and Auditing 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 Group pane are: 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. Page 78

83 Managing the User Database To change the list of users belonging to a group, click the User Membership tab, then click Add or Remove as appropriate. Associating 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, choose Tour > Tour Runs. 2. Double-click the Tour you want. 3. In the Tour Info pane within the Tour Definition dialog box, select the groups you want from the Full Access Group and Data Entry Group drop-down lists. PI Manual Logger User Guide Page 79

84 Security and Auditing PI Server Trust and Security PI Manual Logger communicates with and stores all information in a single PI Server, which is the default PI Server set up by your PI Administrator. Before you start loading tags to PI Manual Logger, configure the server connection to use a Trust login. You can set up PI trusts to map your Windows users to PI users. See the PI Trust Editor Plug-In for SMT3 manual for details on configuring server trust connections, and adding and remove PI Servers from a server list. Setting up PI Trusts using PI SMT 3 Page 80

85 Auditing PI Server List Dialog Box Server Security In addition to the security at the PI Manual Logger application level, a PI3 server allows you to set up security at the point level. A PI Manual Logger user must have write access to write tag values to the PI Server. Auditing In addition to the server security settings described in Server Security (page 81), 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 Data encryption and protection on the device PI Server security Auditing on the PI Server Security on the PC application is integrated with Windows security and PI trusts. When users log into a PC workstation and launch PI Manual Logger, they are authenticated against the PI Manual Logger User Guide Page 81

86 Security and Auditing established PI trust on the default PI Server. Once they are authenticated to the PI Server, they can access data in the PI Server. Furthermore, if they enter data into the PI Server, the changes made to PI values are audited in the PI audit database. Auditing on User Database Changes In Tools > Global Options > Message Logging, if logging is enabled for user database changes (Log user group membership changes, Log user password change events, and Log Admin user group changes), administrators can audit changes in the user database, such as user password changes and user group relationship changes. Auditing on Tour Definition Deletion and Creation In Tools > Global Options > Message Logging, you can change Log tour definition creation events and Log tour definition deletion events to audit Tour definition creation and deletion events. Auditing on Data Transfer All successful data transfer from PI Manual Logger to PI Server is audited and logged into the PI Manual Logger log database. To view these logs, use the Message Log Viewer (page 69). Auditing on Data Changes in PI Manual Logger If a user makes changes to an existing tag value, its timestamp, or 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 65). Page 82

87 Chapter 8: Using PI Manual Logger Mobile In addition to the PI Manual Logger PC application, you can also collect data on a mobile device using PI Manual Logger Mobile. That data designated for collection with a mobile device is defined in a Tour (page 35). A Tour contains a collection of tags and their attributes. The database containing the Tour definition is downloaded to the mobile device, and PI Manual Logger Mobile uses the downloaded Tour definitions to collect data. As data is entered on the mobile device, a Tour Run is created containing the data. The Tour Run is then uploaded to the PI Manual Logger host, where you can review and edit the data before sending it to the PI archive. Alternately, you can configure PI Manual Logger to send the collected data to the PI server once the Tour Runs are transferred to the host. If the device has internet connection to the server hosting the PI Manual Logger Web Services, you can initiate data transfer from the device without the PI Manual Logger PC application installed on the host. This transfer can be done through wired or wireless connection. For details on mobile application installation, supported platforms, system requirements, and configuration, see Installation (page 9). Using Barcodes in Mobile Devices Barcodes can be used as aliases for tag names for the data collection points. During manual data collection, you can scan a barcode and then jump to the data entry screen for the tag associated with the barcode. Note: Barcode scanning hardware varies. See your device User's Manual or consult with your hardware vender to learn how to trigger your barcode scanner. You can use barcodes for individual tags or Tag Groups. PI Manual Logger User Guide Page 83

88 Using PI Manual Logger Mobile Barcodes are mapped to tag names in the Tour Definition dialog box. You can configure (page 44) PI Manual Logger to ask the operator to scan or 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 supports. 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 Code 128 Variable Variable Note: If the Barcode must be scanned before data entry is allowed (page 44) option is enabled, users must first enter a barcode associated with a tag or Tag Group before they can enter data for it. Data Entry Methods PI Manual Logger Mobile supports the following Windows Mobile device input methods: Soft Keyboard Character Recognizer Microsoft Transcriber Hardware Keyboard attached to the mobile device or build-in hardware keyboard In addition, several third-party soft keyboards (large keys and numbers-only keyboards) and other data entry methods (such as barcode scanners) are available and work well with PI Manual Logger Mobile. Page 84

89 Getting Started Getting Started Set Up and Configure Connections Before using a mobile device to collect data, you must install and configure the connection management software on the PC. For details, see Installation (page 9). Set up the connection management software (ActiveSync) in Guest Only mode to avoid unnecessary delay and interruptions in data transfer. Performing 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 before you can perform these mobile device tasks from your PC. PI Manual Logger User Guide Page 85

90 Using PI Manual Logger Mobile Getting Device Information Once you have established a successful ActiveSync connection to a Windows Mobile-based device, you can check the device information through the Device Information menu. To do this, choose Mobile Devices > Device Information. The Mobile Device Information dialog box shows the device OS version, memory information, battery status, and device screen resolution. Configuring a Mobile Device Before collecting data using a mobile device, you must set up the device and then initialize (page 88) the database on the device. To set up the device, choose Mobile Devices > Configuration and Setup. Page 86

91 Getting Started The General device settings are: Main Database Path: The device path to the SQL Server 2005 Mobile database. The file extension must be sdf. Specify a non-volatile memory location, such as a Flash ROM memory address or Flash card (CompactFlash (CF) or Security Digital (SD)) address to reduce the chance of data loss due to battery power failure. Temporary Folder to hold data transferring: A device folder where temporary data is held during data transfer. To leave more room for the main application, do not place the temporary folder in the main RAM. Web Service Server Address: The URL to the installed PI Manual Logger Web Services server Web page. This URL is used during all data transfers that are initialized by the device. Device ID: The connected device's ID. This ID is logged for all Tour Run data the device collects. In the Device Modes tab of Mobile Device Settings dialog box, you can specify the device running on Single User Mode and Single Tour mode. PI Manual Logger User Guide Page 87

92 Using PI Manual Logger Mobile The Device Modes settings are: Single User Mode: when PI Manual Logger is started on the device, there is no login prompt and the specified user is always logged in. This is useful in situations where user authentication on the device is unnecessary. Single Tour Mode: 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. Enable SmartMinimize Icon on device: enables the Windows Mobile SmartMinimize icon. This is disabled by default. Once you specify the device settings, click OK to save the changes on the device. Note: The device must be properly initialized before you can use it. Mobile Database Initialization Once the settings are transferred onto the device, you must initialize the device database. To do this, choose Mobile Devices > Initialize Device Database Page 88

93 Getting Started 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. Transferring Data from the PC to a Mobile Device You can use the Device Data Transfer Console to transfer data between the host database and mobile databases. To launch this dialog box, choose Mobile Devices > Device Data Transfer. The PC Tour List on the left side of the dialog box lists the Tours and Tour Runs in the current PI Manual Logger database. By default, the Tour List is sorted alphabetically by Tour names. The Device Tour List on the right side of the dialog box lists Tours and Tour Runs on the currently connected mobile device. Each list has a toolbar. PI Manual Logger User Guide Page 89

94 Using PI Manual Logger Mobile The PC Tour List tools are: Refresh: refresh the list Logs: view the current data transfer logs 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 a PI Manual Logger administrator). 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. Page 90

95 Getting Started The Device Tour List tools are: Refresh: refresh the list Transfer: start data transfer Info: view the device information. Downloading Tour Definitions To download Tour and Tour Run data onto your mobile device: 1. Choose Mobile Devices > Device Data Transfer. 2. Select the Tours and Tour Runs you want to transfer. Ctrl-click to select multiple items. 3. Click. The Tours and Tour Runs to be transferred appear in the Device Tour List, highlighted in blue italic typeface. 4. Click to select the available transfer options. PI Manual Logger User Guide Page 91

96 Using PI Manual Logger Mobile On the Receive Options page, you can specify whether to attach a timestamp to a temporary database file when importing data. For example, if this box is checked and the device database filename is pimlmobile.sdf, when it is transferred to the PC its name is appended with the timestamp, such as pimlmobile_2006_4_12_12_35_30.sdf. You can also specify whether you want to import all tour runs or just those completed tour runs into the master SQL Server database. 5. Click the Send Options tab. On this page you can specify whether to reload tour definitions on the device and to reload user databases on the device. 6. Click to initiate the transfer. Caution: Any existing Tour and Tour Run data on the device is erased during the transfer. In addition, after the data transfer, any previous Tours on the device that were not selected are erased from the device. Once the data successfully transfers to the device, you can launch PI Manual Logger Mobile and start collecting data. Launching PI Manual Logger Mobile Before using a mobile device for data collection, you must first download configuration information to the mobile device. Page 92

97 Getting Started Before launching 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. Once the application is up and running you can use the soft keyboard or any of the other data entry methods for data entry. To launch the mobile application, choose Start > Programs > PI System > PimlMobile. The login information is the same as your PI Manual Logger user account and password you use on the desktop. Once you log in successfully, the Tour List screen appears. If you are configured for single-user mode (page 86) for devices, you are not asked to log in. Instead, the screen indicates you are in single-user mode. If you launch 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 Page 93

98 Using PI Manual Logger Mobile Main Menus The File Menu The PI Manual Logger Mobile File menu items are: Start a new run: Start a new Tour Run. You can also tap. The user ID defaults to the login name, and the Tour Timestamp defaults to the nearest hour. Page 94

99 Getting Started Edit/Resume run: Edit previously collected data. You can also access this function in the Tour List: with the cursor on a child node, tap or the File - Edit/Resume Tour to edit previously collected data. Update Data from Host: Receive Tours and updated cached information from PI Manual Logger Web Services. Send Data to Host: Send collected data to the PI Manual Logger Web Services host and (optionally) send data to the PI Server Message Log: Show the local message log (page 105) saved on the mobile device. Send Log to Server: Send the message log stored on the device to the PI Manual Logger Web Services host and clear the log on the local device. 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. The Tools Menu The PI Manual Logger Mobile Tools menu items are: System Clock: Link to the system clock setting on the device. You can 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 (page 113) with the PI Manual Logger Web Service host. This is useful for restoring the application device after the device power was drained. 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 Page 95

100 Using 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. Page 96

101 Tour List The Help Menu The PI Manual Logger Mobile Help menu items are: About: Shows the summery of system information regarding the device. The displayed system information can be used for trouble shooting and diagnose potential problems. Contents: Launches the PI Manual Logger Mobile help system Note: The device help includes only basic help information. For complete information on PI Manual Logger, see the PI Manual Logger User Guide (this document). Tour List The Tour List is organized in tree view. The top nodes in the tree view are tours, and the subnodes 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. PI Manual Logger User Guide Page 97

102 Using PI Manual Logger Mobile Main Toolbar The PI Manual Logger Mobile toolbar items are: Tool Description Initiate a bidirectional data transfer between the server and the device. Any collected manual data is sent to the host 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 launching the login screen Tour and Tour Run Toolbar When a Tour is selected: When a Tour Run is selected: 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 for the Tour to use this tool. Page 98

103 Data Entry Screen Data Entry Screen The data entry screen shows the tag name and descriptor, tag value, and timestamp. Depending on the Timestamp Tour Options (page 43) settings, the default tag timestamp is set to either the Tour 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 select a pre-configured tag status from the drop-down list: PI Manual Logger User Guide Page 99

104 Using PI Manual Logger Mobile 2. Click to process the entry and go to the next due tag. Notes: Depending on your barcode scan option setting (page 44), either a prompt to scan a barcode or the next tag in the sequence appears. Depending on your Limit Check setting (page 43), if you enter a value that violates one or more limits specified for the tag, the Limit Violation Warning dialog box may appear. 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 Page 100

105 Data Entry Screen 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 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: The navigation buttons go through all the tags in a Tour, regardless of whether a tag is due or has value entered. To navigate to the next tag that is due, choose Go > Go to Next Empty Tag, or click. 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 the Data Validation page (page 53)). 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 Indicates that there are comments associated with the current tag PI Manual Logger User Guide Page 101

106 Using PI Manual Logger Mobile Comment Page To view or modify an existing comment, tap. To enter a new comment for a tag value, tap. Page 102

107 Data Entry Screen The comment tag shows the target that the current comment is associated with. The target can be an individual tag with the icon, a Tag Group with the icon, or the whole Tour with the icon. Note: Tap the comment templates icon to use any available pre-defined comments. 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: Icon Indicates There are tags in the group that are due for collection There are no tags in the group that are due for collection All "due for collection" tags in the group have values entered The group contains tags with limits violations PI Manual Logger User Guide Page 103

108 Using PI Manual Logger Mobile When you select a Tag Group in the list, the toolbar for Tag Groups also appears. To set the status of a Tag Group, select the Tag Group and tap. The target name and icon displayed in the Set Status window shows the current target for which the status is set. The target can be a Tag Group ( ) or the whole tour ( ). Page 104

109 Data Entry Screen To add a comment to a Tag Group, select the Tag Group and tap the upper left comment is associated with all subgroups and tags within the group.. The To view the data entry screen for a tag, select the tag and tap. Tag History Page 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 you want 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 you want from the list and tap, or choose Value > Use Previous Value and Comment. Message Log Page To view a message log for a Tour or Tour Run, tap the Log tab at the bottom of the data entry screen. PI Manual Logger User Guide Page 105

110 Using PI Manual Logger Mobile From the Log page, 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. Page 106

111 Data Entry Screen 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 pre-defined list of templates, tap. Audit Log Page 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. Signature Page If a Tour is configured to require a handwritten signature before saving the tour, the signature page appears when you close the Tour Run. PI Manual Logger User Guide Page 107

112 Using PI Manual Logger Mobile Click OK to save the signature and associate it with the current Tour Run edit event. If you click Cancel, the signature is not saved to the Tour Run. Click the Clear Signature icon Run edit event again. to clear the current signature screen and sign the Tour Note: Once you save the signature image with the Tour Run edit and transfer the Tour Run to the SQL database, you can view the signature later in the Tour Run History dialog box. Data Entry Menus Tag Menu Page 108

113 Data Entry Screen 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 Tag Attributes: Display the Tag Attributes dialog box 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. Click Yes to close the run. Later, you can choose File > Edit/Resume Run to enter more data. Click No to continue entering data. Choose Go > Go To Next Empty Tag to locate empty tags. Discard and Close: Discard any changes made to the current Tour Run and exit the data entry screen 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. PI Manual Logger User Guide Page 109

114 Using PI Manual Logger Mobile Go To Next Empty Tag: Launch the data entry screen for the next empty tag (that is, one for which a value is not yet entered). Scan a Barcode: Launch 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. 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 44), 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 the PI Manual Logger Release Notes. Add a comment: Launches the Comments page for the current tag. Page 110

115 Data Entry Screen Value Menu In the data entry screen, the Value menu items are: Use Previous Value: Use the most recent historical value as the current 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 Reverse digits: Transpose the digits for the current value. This is useful for meters where the digits have to be read from right to left. If 1234 is entered and you select this menu item, the entry becomes 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 determined in the Other page in the Tour Options dialog box. Time Menu In the data entry screen, the Time menu items are: PI Manual Logger User Guide Page 111

116 Using PI Manual Logger Mobile Enter Current Time: Use the current Time as the timestamp for the current tag Enter Tour Time: Use the Tour Timestamp as the timestamp for the current tag Edit Tag Timestamp: Make the tag timestamp box editable so you can enter a new time in it. Choose this menu option again to toggle between an editable and read-only timestamp. Edit Tour Timestamp: Launch a dialog box to edit the current Tour's timestamp. If the tags are configured to default to the Tour timestamp (page 43), then the timestamps for all the tags reset to the new Tour timestamp. Restore/Clear Tag Timestamp: Launch 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. View Menu In the data entry screen, the Time 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: Launch the User 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. Device Status: Show the current device memory usage, batter power, and network connectivity status. Data Transfer You can initialize a data transfers from the PC or device. To download new Tours onto the device, you must initiate the data transfer from the PC. For details, see Transferring Data from the PC to a Mobile Device (page 89). Page 112

117 Data Transfer Note: Before downloading data to the device or uploading data from the device, you must set up ActiveSync (page 26) properly for file transfers between device and PC. Transferring Data from the Mobile Device To transfer data from the mobile device to the PC, you must have an active internet connection on the device to the target server running PI Manual Logger Web Services. To initiate bi-directional transfer from the mobile device, click. After a confirmation dialog box, the device sends your collected data to the host, and downloads any updated Tour definition, global options or any 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 erases all existing Tour data during this step. If there is previously collected data on the mobile device that has not yet been sent to PI Manual Logger, it will be erased. Time and Clock Synchronization You can manually synchronize the time and clock on the device with the targeting server running PI Manual Logger Web Services. To synchronize the device clock, choose Tools > Sync Date/Time. Once the device is connected to the server, PI Manual Logger retrieves the current data time from the 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. 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. PI Manual Logger User Guide Page 113

118 Using PI Manual Logger Mobile To configure AutoSync, select from the Windows Start menu > Programs > PI System > PI Manual Logger > PIML AutoSync Setup. The options are: Enable AutoSync: Check this box to use PI Manual Logger AutoSync feature. Enable ActiveSync Partnership: If this is disabled, PI Manual Logger AutoSync runs in guest only mode. Enable Auto Sync Confirmation Dialog: Check this to display a confirmation dialog box before AutoSync starts. This is helpful if you need to frequently log on and off of your Windows workstation while the device is docked. Dialog timeout time: Indicates how long the confirmation dialog box appears. Once the dialog box times out, AutoSync starts. This is useful under unattended docked environments. Note: If Dialog timeout time is 0, the confirmation dialog box does not time out. Page 114

119 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 what user made the change Successful or failed archive action for Tour Run data, including details on what 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: Which user logged on or off the PI Manual Logger system and when What Tours are created and changed How many tags failed to archive or were overwritten during the user session When adding data via mobile devices, PI Manual Logger Mobile also records messages and user session activities. Once the mobile device is connected to the host (a PC or PI Server), PI Manual Logger downloads the message log from the device and saves it in the database. For details on message logging in PI Manual Logger Mobile, see Message Log Page (page 105). To view the history of the PI Manual Logger message log, choose File > Message Log. In the Message Log Viewer dialog box, you can view logs in Grid View and Plain Text View (by clicking the tabs). To view all logs in the PI Manual Logger database, click Show Saved Logs. PI Manual Logger User Guide Page 115

120 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 launch the Configuration Tools, choose from the Windows Start menu > Programs > PI System > PI Manual Logger > PIML Configuration. You can view the logs in Grid View or Plain Text View. Page 116

121 PI Manual Logger Configuration Tool PI Manual Logger User Guide Page 117

122

123 Appendix B: Web and Windows Services PI Manual Logger Web Services PI Manual Logger Web Services (PimlWebServices) let you manage Tours and Tour Runs through ASP.NET Web services interface. Any internet-connection enabled devices can communicate with the Web Services and transfer data between the PI Manual Logger database and a mobile device. Through the PI Manual Logger Web Services you can: Retrieve the system data time Retrieve any global settings Retrieve the selected Tour definitions as a dataset Retrieve the user database in PI Manual Logger as a dataset Upload any logs Upload Tour Run data as a dataset The default URL for PI Manual Logger Web Services is PI Manual Logger User Guide Page 119

124 Web and Windows Services For details on setting up PI Manual Logger Web Services, see Configuring PI Manual Logger Web Services (page 23). PI Manual Logger Windows Services In addition to the main PI Manual Logger Windows application, and the Web services interface, PI Manual Logger also includes a Windows Services program that you can use to store cached data in the PI Manual Logger database synchronized with the targeted PI Server. Access the PI Manual Logger Windows Service from the Windows Computer Management dialog box. The PI Manual Logger Windows Service: Periodically updates the cached tag values in the PI Manual Logger database Periodically updates the cached tag attributes and digital states in the PI Manual Logger database Page 120

125 PI Manual Logger Windows Services Periodically checks any queued future data in the PI Manual Logger database and sends them to the targeted PI Server when the queued time passes The PI Manual Logger Windows Services log its progress information in the Windows Application Event Log. Use the Windows EventLog viewer to check the status of the Windows Services. PI Manual Logger User Guide Page 121

126

127 Appendix C: Global Settings and Maintenance Updating Tags 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, choose File > PI Tags and Digital States. 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 targeting PI Server, update cached PI values in the PI Manual Logger database and send queued data to the PI Server. PI Manual Logger User Guide Page 123

128 Global Settings and Maintenance To update tag attributes for one tag, select the tag you want to update, right-click, and choose Update Tag Attributes for Selected Tags. To update tag attributes for all tags, right-click in the PI Tags page and choose Update Tag Attributes for All Tags. This may be a time-consuming process depending on the number of tags in the database. To remove tags from PI Manual Logger, right-click in the PI Tags page and choose Remove Selected Tags from PIML. You can remove tags that were removed from the PI Server since they were added to PI Manual Logger, and 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 choose Update Digital States. Archive Values The Archive Values page displays the archived values for a PI Tag. To display these values, in the PI Tags page, select a tag, then right-click and choose Show Archive Data. In the Archive Values page, you can display ad hoc trends, show annotation details, add a comment to an existing PI value, or delete selected values from the PI Server. Page 124

129 Queued Data 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 on account permissions, see Global Options (page 31). Queued Data To send queued data to the PI Server, click the Queued Data tab, right-click anywhere on the page, and choose Send to PI. PI Manual Logger User Guide Page 125

130 Global Settings and Maintenance In addition to this feature, the PI Manual Logger Windows Services (page 120) also sends queued data to the PI Server once the timestamp of the queued data becomes current. Page 126

131 Appendix D: Tour Migration The PI Manual Logger Tour Migration tool is an add-on application for PI Manual Logger 2.0 that allows you to migrate existing PI Manual Logger 1.4.x tour data to the Microsoft SQL Sever-based database format. Migrating Tour Data Note: Before importing tour data into the PI Manual Logger 2.0 database, you must set up the correct SQL connection to your SQL Server database. For details, see SQL Server Configuration (page 17). To migrate data from PI Manual Logger 1.4.x tour definitions: 1. Choose from the Windows Start menu, PI System > PI Manual Logger > PIML Tour Migration Tool. PI Manual Logger User Guide Page 127

132 Tour Migration 2. Click Browse to browse to your PI Manual Logger 1.4.x Access database. The database file must have the.mdb suffix. 3. Click Start to start the tour migration process. The Assign Permission Groups dialog box appears. 4. Choose the appropriate full permission and data entry permission groups for all tours that are being migrated. For details on permission groups, see Managing the User Database (page 75). The Tour Migration Tool window shows the migration process details. Page 128

133 What Is Migrated PI Manual Logger 2.0 records all tour migration events in its Message Logs. Use the PI Manual Logger Message Log Viewer (page 69) for auditing or reviewing purposes. What Is Migrated The following tour information is migrated to the PI Manual Logger 2.0 database format: Tour name Tour description All tags defined in the tour All comment tags Tag limit specifications All equipment defined in the tour All barcodes defined in the tour All location text defined in the tour 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.0 database format: Tour options Tour permission groups and permission levels Tour collection specifications PI Manual Logger User Guide Page 129

134

135 Appendix E: Installing and Configuring SQL Server 2005 Express Edition Microsoft SQL Server 2005 Express Edition is a free and easy-to-use database product that is based on SQL Server 2005 technology. This section details the steps to install and configure SQL Server 2005 Express Edition for use with PI Manual Logger. System Requirements Download and install the following components before installing SQL Server 2005 Express Edition: The latest service packs on your Windows operating system Microsoft.NET Framework 2.0 You can download SQL Server 2005 Express Edition from Microsoft's Web site. In addition, we recommend that you download Microsoft SQL Server Management Studio Express, which provides a graphical interface to manage basic database administration tasks. Installing SQL Server 2005 Express Edition To install SQL Server 2005 Express Edition: 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: PI Manual Logger User Guide Page 131

136 Installing and Configuring SQL Server 2005 Express Edition 4. In the Authentication Mode screen, we recommend that you specify Mixed Mode. 5. Specify an sa password for the SQL Server 2005 default administrator. The sa account is used to manage and perform administration tasks on the database server. Page 132

137 Installing SQL Server 2005 Express Edition 6. If you install SQL Server 2005 Express Edition using Advanced Options, the Instance Name screen appears. The default SQL Server path is: \\ServerName\SQLExpress You may specify the database server to a different path, such as: \\ServerName\PIMLSQLExpress PI Manual Logger User Guide Page 133

138 Installing and Configuring SQL Server 2005 Express Edition If you specify Default instance for installation, then the path to your SQL Server is \\ServerName instead of \\ServerName\SQLExpress. 7. Make a note of the database server path, as it is the path that PI Manual Logger SQL Server Configuration dialog uses. Note: SQL Server 2005 supports multiple SQL Server instances on a single server or processor, but only one instance can be the default instance; all others must be named instances. A computer can run multiple instances of SQL Server concurrently, and each instance runs independently of other instances. All instances on a single server or processor must be the same localized version of SQL Server SQL Server 2005 supports up to 16 instances on the same computer. Each instance has a unique path. Installing and Using SQL Server Management Studio Express To install SQL Server Management Studio Express, double-click the setup executable file. To launch SQL Server Management Studio Express, choose Start > All Programs > Microsoft SQL Server 2005 > SQL Server Management Studio Express. In the Connect Page 134

139 Installing and Using SQL Server Management Studio Express to Server dialog box, specify the SQL Server instance you want to connect to and the authentication mode you want to access. You can log in through Windows authentication or SQL Server authentication. To attach or manage the PI Manual Logger SQL Server database, you must have administrative permissions to the server. If you attach the PI Manual Logger template database onto the SQL Server Express, copy the files onto a local folder on the computer where SQL Server Express is installed. In addition, make sure the SQL Server Express account has Windows read/write permission to the database files; otherwise the following error messages may appear: PI Manual Logger User Guide Page 135

140 Installing and Configuring SQL Server 2005 Express Edition Alternatively, you can move 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. Note: If you use a SQL Server instance other than the default, copy the database file to its corresponding data folder, which is usually C:\Program Files\Microsoft SQL Server\MSSQL.2\Data or similarly numbered paths. Once you attach the database file, follow the instructions in SQL Server 2005 (page 17) to allow integrated Windows security on the database, or specify the security for the optional PI Manual Logger Web Services component to access the PIMLWindows database. Page 136

141 Remote Connection to SQL Server Express 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. PI Manual Logger User Guide Page 137

142 Installing and Configuring SQL Server 2005 Express Edition In addition, set SQL Browser Services Startup type to Automatic and set Service status to Running. Note: SQL Server 2005 Express Edition supports concurrent connections and multiple PI Manual Logger clients connecting to the same database at the same time. Page 138