Operator instructions

You use the Operator Instructions box on the Tag Configuration tab in the Tour Configuration window to enter tag attributes.

Sample operator instructions

You can provide an instruction for a meter that needs recalibrating:

Meter needs recalibrating; subtract 50 from reading before entering data.

You can include an instruction to the person entering data, such as:

Verify repair to steam valve 31.

You can 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.

Hyperlinks in instructions

You can insert a hyperlink to a file or an HTTP web site or an FTP site in the operator instructions. Multiple hyperlinks can appear in operator instructions used for tour runs executed on a PC, and the operator can choose the hyperlink to open. Operator instructions for mobile devices can contain only one working hyperlink.

When the operator executing a tour run selects a tag with operator instructions that contain a hyperlink, the following actions take place:

• On a PC: the operator instructions are always visible in the window. The operator can choose from the hyperlinks, if there are more than one, and open it. A browser opens automatically when the link is clicked.

• On a Windows Mobile device: if the Tour Option Automatic pop up display of Operator Instructions is True, the operator instructions open automatically and display the hyperlink. The operator can do the following:

  • Click Go to Link, accessing the web site if the device has internet access, or opening the file if the file exists on the device.

  • Click Cancel if it is not necessary to view the hyperlink.

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

Hyperlink syntax

Use the standard syntax of a Universe Resource Identifier (URI) for a hyperlink. Refer to the Uniform Resource Identifier: Generic Syntax web site for additional information about syntax.

The following are syntax examples:

• http://<host_name> Example: http://osisoft.com This hyperlink accesses the OSIsoft main web site.

• ftp://ftp.<server_address> Example: ftp://ftp.gimp.org This hyperlink accesses the currently valid FTP site at gimp.org.

• \<path\file_name> or file:\\\<path\file_name>

• Examples: \MY DOCUMENTS\my_file.txt This hyperlink opens the file called my_file.txt located in the My Documents folder of the mobile device.

• \MY DOCUMENTS\Business\my_file.txt This hyperlink opens the file called my_file.txt located in the My Documents\Business folder of the mobile device.

• file:///c:\<file_name> This link opens a file located on a PC. Example: file:///c:\my_file.txt This hyperlink opens a file called my_file.txt located at the root of drive C:

• file:///\<path\file_name> Example: ///MY%20DOCUMENTS\my_file.txt This hyperlink opens the file called my_file.txt located in the My Documents folder of the mobile device.

Hyperlink guidelines

Note these guidelines for constructing a hyperlink:

• If the path or file name contains spaces, verify that these are replaced with the characters %20.

• For links and files on the PC, OSIsoft recommends that you open the file or web site in a browser, copy the hyperlink, and then paste it into the Operator Instructions box. PI Manual Logger converts it appropriately. For example:

• http://portal.osisoft.com/sites/Development/ClientApplications/ManalLogger/Shared%20Documents/Presentations/OperatorInstructions/Fire%20Extinguisher%20Inspection%20Procedures.htm

• PI Manual Logger may prompt you for authentication.

• For links and files on the mobile device, OSIsoft recommends that you first test opening the file or web site in Internet Explorer/Pocket Explorer on the device and enter the link in the Operator Instructions box the same way you opened it on the mobile device.

• For a file schema, if you type in the link to the file manually, instead of copying the link from Internet Explorer as described in the previous bullet, be sure to use the third forward slash, which acts as a delimiter ( / ).

• For instructions that you want to display on a mobile device, you can enter lines of text or a hyperlink. If you include text and a hyperlink, or multiple hyperlinks, all entries appear as text.

• On the Tour Options tab, use the Automatic pop up display of Operator Instructions before data entry (on mobile device) option to ensure that operator instructions appear automatically on the mobile device. The PI Manual Logger default is set to true.

• Although you can link to and display a file on the mobile device, OSIsoft recommends that you link to an HTTP or FTP site where you can maintain a single file, in a central location, accessed by all devices. Depending on the file type, a mobile device may or may not return the operator to PI Manual Logger after the file is closed. The operator may need to redisplay PI Manual Logger manually.

• You can link to any file for which there is an application that can display it, for example, .jpg or .png graphic files, .txt text files, and so forth.

• After you enter a hyperlink, test it to verify that the accessed file or site opens.