Please ensure Javascript is enabled for purposes of website accessibility
Powered by Zoomin Software. For more details please contactZoomin

PI Builder (PI Server 2024 R2)

List of data retrieval settings

  • Last UpdatedDec 13, 2024
  • 3 minute read

The Retrieve tab of the Settings window contains settings that control PI Builder behavior when retrieving data from PI AF or PI Data Archive.

The following table describes the settings available on the Retrieve tab of the Settings window.

Category

Setting

Description

Worksheet

Prompt to append or overwrite

If selected (default setting) and the current worksheet contains any content, PI Builder prompts you to append or overwrite that content before retrieving data.

Append to worksheet

If selected (after Prompt to append or overwrite is cleared), always appends to existing content in the worksheet without asking the user.

Clear Worksheet options

Clear remainder of worksheet

If selected, when retrieving data into the worksheet, PI Builder clears remaining contents in the worksheet from the first row being populated. For example, if appending and row 8 is the first empty row, this option causes the contents starting at row 8 to be cleared to the end of the worksheet, prior to populating the worksheet starting at row 8.

Overwrite and add empty cell boundary

If selected (default setting), when retrieving data into the worksheet, PI Builder overwrites existing data and clears the two columns immediately to the right of the last column retrieved and the two rows immediately below the last row retrieved; this forms an empty cell boundary of two columns and two rows around the newly retrieved data.

Clear to empty cell boundary

If selected, when retrieving data into the worksheet, PI Builder first clears all data to the empty cell row and column boundaries. Then, PI Builder writes the newly retrieved data to the worksheet. If the cleared area is smaller than that required by the newly retrieved data, behavior differs:

  • If you are overwriting data, behavior reverts to Overwrite and add empty cell boundary.

  • If you are appending data, behavior reverts to Clear remainder of worksheet.

Column

Prompt for columns when overwriting

If selected (default setting) and you are not appending to an empty worksheet, PI Builder opens the Select Object Types and Column Headers window before retrieving data.

If the worksheet is not empty and you are appending data to it or if the option is not selected, PI Builder uses the existing column headers to the extent possible and retrieves data without opening the Select Object Types and Column Headers window.

Expand columns to fit contents

If selected (default setting), PI Builder expands the column width to match the width of the contents retrieved (up to 80 characters wide).

Cell Content

Shade non-applicable cells

If selected, PI Builder applies a cross-hatch shading pattern to cells not applicable to the object type when retrieving data. For example, if you retrieve element and attribute data from PI AF and select this check box, PI Builder shades cells in the AttributeValue column in rows where the ObjectType is Element because elements do not have attribute values.

Append units of measure to value cells

If selected, PI Builder appends the default unit of measure, if any, to attribute values retrieved into the AttributeValue column.

Show simplified configuration strings

If selected (default setting), PI Builder removes PI System and tag identifiers (GUIDs) from configuration strings retrieved from PI AF.

Show milliseconds on time stamps

If selected, PI Builder shows any milliseconds in time stamps, such as 2/9/2018 9:00:00.258 AM. To retain maximum precision, select this check box to edit and view milliseconds in time stamps.

If not selected, PI Builder truncates any milliseconds in time stamps.

Time Stamp Display

Specifies how dates and times retrieved from the PI System are displayed in a worksheet. The following options are available:

  • Local Time Zone (default setting)

    Specifies that dates and times are displayed in the local client machine's time zone.

  • Server Time Zone

    Specifies that dates and times are displayed in the time zone configured for the connected PI AF server (for PI AF objects) or the connected Data Archive (for PI points).

    The format of dates and times are:

    Date Time Time_Zone_Offset

    where Time_Zone_Offset is an indication of the number of hours' difference between the connected server's time zone and Universal Coordinated Time (UTC). For example, if the server's time zone is U.S. Eastern Time, the date and time might look as follows:

    2/28/2018 08:11:34 -5:00

  • UTC

    Specifies that dates and times are displayed in Universal Coordinated Time. This includes an indicator at the end of the date and time string (Z).

TitleResults for “How to create a CRG?”Also Available in