PI Connector Administration

2.8.6
© 2015-2025 AVEVA Group Limited and its subsidiaries. All rights reserved.
No part of this publication may be reproduced, stored in a retrieval system, or transmitted, in any form or by any means,
mechanical, photocopying, recording, or otherwise, without the prior written permission of AVEVA Group Limited. No
liability is assumed with respect to the use of the information contained herein.
Although precaution has been taken in the preparation of this documentation, AVEVA assumes no responsibility for
errors or omissions. The information in this documentation is subject to change without notice and does not represent a
commitment on the part of AVEVA. The software described in this documentation is furnished under a license
agreement. This software may be used or copied only in accordance with the terms of such license agreement. AVEVA,
the AVEVA logo and logotype, OSIsoft, the OSIsoft logo and logotype, ArchestrA, Avantis, Citect, DYNSIM, eDNA, EYESIM,
InBatch, InduSoft, InStep, IntelaTrac, InTouch, Managed PI, OASyS, OSIsoft Advanced Services, OSIsoft Cloud Services,
OSIsoft Connected Services, OSIsoft EDS, PIPEPHASE, PI ACE, PI Advanced Computing Engine, PI AF SDK, PI API, PI Asset
Framework, PI Audit Viewer, PI Builder, PI Cloud Connect, PI Connectors, PI Data Archive, PI DataLink, PI DataLink Server,
PI Developers Club, PI Integrator for Business Analytics, PI Interfaces, PI JDBC Driver, PI Manual Logger, PI Notifications, PI
ODBC Driver, PI OLEDB Enterprise, PI OLEDB Provider, PI OPC DA Server, PI OPC HDA Server, PI ProcessBook, PI SDK, PI
Server, PI Square, PI System, PI System Access, PI Vision, PI Visualization Suite, PI Web API, PI WebParts, PI Web Services,
PRiSM, PRO/II, PROVISION, ROMeo, RLINK, RtReports, SIM4ME, SimCentral, SimSci, Skelta, SmartGlance, Spiral Software,
WindowMaker, WindowViewer, and Wonderware are trademarks of AVEVA and/or its subsidiaries. All other brands may
be trademarks of their respective owners.
U.S. GOVERNMENT RIGHTS
Use, duplication or disclosure by the U.S. Government is subject to restrictions set forth in the license agreement with
AVEVA Group Limited or its subsidiaries and as provided in DFARS 227.7202, DFARS 252.227-7013, FAR 12-212, FAR
52.227-19, or their successors, as applicable.
AVEVA Legal Resources: https://www.aveva.com/en/legal/
AVEVA Third Party Software Notices and Licenses: https://www.aveva.com/en/legal/third-party-software-license/
 PI Connector Administration
Contents

Contents
Data source configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4
Add a data source . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4
Remove a data source. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4
Discover data source contents . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4
Learn how to select data . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5
Create a data selection query . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6
Selection Rules fields . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7
Edit a data selection query . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7
Configure tag naming . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7
Automatic tag naming . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8
Custom tag naming . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9
View Summary . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11

© 2015-2025 AVEVA Group Limited and its subsidiaries. All rights reserved. Page 3
 PI Connector Administration
Data source configuration

Data source configuration

The following topics describe how to configure data sources for a connector using PI Data Collection Manager.
Alternatively, you can configure data sources using the PI Connector Administration site. For details, see the user
guide for the specific connector.

Add a data source

1. In PI Data Collection Manager, select a connector.
2. In the right pane, select the Data tab.
3. Select Add Data Source.
4. Under Data Source Settings, enter connector-specific information, which is used to identify and configure
the data source.
The fields in this section vary depending on the specific connector. For more information, see the user guide
for the specific connector.
5. Select Save.

Remove a data source

1. Select the connector that is connected to the data source you want to remove.
2. In the right pane, select the Data tab.
3. Under Manage Data Sources, select one or more data sources that you want to remove.
4. Select Remove Data Source.
5. In the confirmation dialog box, select Delete Data Source 'data source name'.

Discover data source contents

After the data source is added, you need to discover the contents of the data source.
Note: Some connectors do not support discovery of data source contents. If you use a connector that does not
support discovery, see the connector's user guide for details on collecting data.

1. Select a data source.

2. In the right pane, select the Data tab.
3. Select Discover Data Source Contents.
Note: Data type changes for previously discovered static AF Attributes are not supported and will cause
discovery to fail.

© 2015-2025 AVEVA Group Limited and its subsidiaries. All rights reserved. Page 4
 PI Connector Administration
Data source configuration

Learn how to select data

After data discovery is finished, you can specify which of the discovered assets and measurements to collect and
store in the PI System, and then configure tag naming.

1. Select a connector.
2. On the right panel, select the Data tab, and then select Select Data.
A data-selection pane is displayed. The top section, Selection Rules, is blank when you first arrive at this
pane. Once you select data, it shows the queries that you have created. The Selected Data section below
shows a hierarchy of all the discovered data.
3. In the Selected Data section, select the triangle next to the checkbox to expand the data source root
element, and then expand subsequent child elements to view specific assets.
Selections highlighted in green indicate data that is newly discovered since the last discovery.
4. Select the boxes for the assets that you want.
When you select a box that has child assets, all the child assets are selected as well.
As you select assets, queries appear in the Selection Rules section. You can customize these queries or
create your own. For more information, see Create a data selection query and Edit a data selection query.
5. To bundle your selections under a common ancestor, select the Group individual selection at the same level
into one query from the drop down menu.
For example, with Group individual selection at the same level into one query selected, if you expand
localhost > AcroRd32 and select the child objects % Processor Time, Executable location, and Executable, the
child objects are bundled in one query with the common AcroRd32 ancestor.

© 2015-2025 AVEVA Group Limited and its subsidiaries. All rights reserved. Page 5
 PI Connector Administration
Data source configuration

If Group individual selection at the same level into one query is not selected, each child object that you
select appears in a separate query.
6. After you have selected all the data you want to collect, select Next.
7. In the Tag Name Configuration section, specify tags to be automatically or manually named after data is
selected, and then select Next.
For more information, see Configure tag naming.
Note: Some connectors do not support tag naming. Refer to the connector user guide to determine if the
connector supports tag naming.The only way to ensure that all new assets are always automatically added is
to select the top root element in the hierarchy.
8. Select Save.

Create a data selection query

To specify that certain types of data are always selected, you can create queries or customize existing queries.

1. Complete all steps in Discover data source contents and steps 1-3 in Learn how to select data.
2. In the Select Data for Connector_Name pane, select New Selection Query.
3. Under Selection Rules, specify the criteria for the query you want to build. For example, to select all the
Thread Count properties, you could create the following query:

For more information about the fields, see Selection Rules fields.
4. Select Run Selection Query.
Running the preceding example query would result in the following selections:

© 2015-2025 AVEVA Group Limited and its subsidiaries. All rights reserved. Page 6
 PI Connector Administration
Data source configuration

Selection Rules fields

Field Options and description

Action Select selects all assets that match the query. Deselect
deselects all assets that match the query.

Selection Any object selects any object that matches the query,
regardless of whether it is an asset or property.
Assets selects only assets that match the query.
Properties selects only properties that match the
query.

Constraint If you select Where, a condition line appears in which

you specify additional conditions for the query. If you
select Everywhere, no additional conditions are added
to the query.

Condition Specify a condition, such as an asset Name or Type.

Operator Specify an operator, such as Starts With or Does Not

Contain.

No label Enter a search string.

Edit a data selection query

As you select data from a data source, queries are automatically created based on the data you selected. You can
customize a query so that it applies to all the data. For example, you might want to select all processes from the
local machine that start with 'c', but selecting them individually could be time consuming. Instead, you can
create a selection query.
Complete all steps in Discover data source contents and steps 1-4 in Learn how to select data.

1. On the data selection screen, select New Selection Query.

2. Under Selection Rules, edit the criteria.
For example, you could select one process to create the following query:
Select > Any Object > Where > Path > Starts With > localhost|c
3. Select Run Selection Query.

Configure tag naming

You can specify tags to be automatically named or custom named after data is selected. The following topics
describe how to configure tag naming in PI Data Collection Manager for automatic or custom tag naming.
Note: Some connectors do not support tag naming. Refer to the connector user guide to determine if the
connector supports tag naming.

© 2015-2025 AVEVA Group Limited and its subsidiaries. All rights reserved. Page 7
 PI Connector Administration
Data source configuration

Automatic tag naming

After you select data, in Configure Tags you can configure tags to be named automatically.
To customize tag names, see Custom tag naming.

1. Select Automatic under Tag Name Configuration to automatically name tags.

2. Select Next to proceed.
The connector applies the automatic tag names.

3. Check automatic tag names.

On the right hand side of the screen is a list of PI Servers (the list includes PI Servers configured on your node
map). You can select Check Tag Names to see whether tags with matching names exist on the PI Server. If a
tag exists, the Action column shows that the connector will use the existing tag. If there is a point type
mismatch between the existing tag and the data that will be sent by the connector, the Action column will
indicate the mismatch and a warning will display to show what point type the existing tag should be changed
to. If the tag does not exist, the Action column shows that the connector will create a new tag.

© 2015-2025 AVEVA Group Limited and its subsidiaries. All rights reserved. Page 8
 PI Connector Administration
Data source configuration

Custom tag naming

After you select data, in Configure Tags you can customize tag names.
Note: To name tags automatically, see Automatic tag naming.

1. Select Custom under Tag Name Configuration. The Tag Naming Worksheet buttons are enabled on the right
hand side of the window.
2. You can select to either export or import a worksheet (CSV) file.
a. Select Export to download a worksheet (CSV) file.
The first column contains the automatic name. You use the second column to provide a custom name.
When you are done populating the worksheet, save it as a CSV file.
b. Select Import to upload your custom names to PI Data Collection Manager.

© 2015-2025 AVEVA Group Limited and its subsidiaries. All rights reserved. Page 9
 PI Connector Administration
Data source configuration

After you import a worksheet, the table updates to reflect your custom names:
a. The automatic names are shown in the first column, and the custom names in the second column.
For rows that include a custom name, the automatic name is dim to emphasize the custom name.
b. If a custom name contains illegal characters, it will display an error icon.
c. You can select a cell in the second column to edit its contents (only available after you have imported
a worksheet).

3. Review custom name tags.

With Tag Name Configuration selected to Custom and a tag naming worksheet imported, Check Tag Names
and the Action column function differently.
If there is a custom name in a row, the Action column applies the following to the custom tag name:
a. If a tag matching the custom name exists, the connector will use the custom name.
Note: If there is a point type mismatch between the existing tag and the data that will be sent by the

© 2015-2025 AVEVA Group Limited and its subsidiaries. All rights reserved. Page 10
 PI Connector Administration
Data source configuration

connector, a warning will display to indicate what point type the existing tag should be changed to. This
applies to both the automatic tag name and custom tag name.
b. If a tag matching the custom name does not exist, but a tag matching the automatic tag name is found,
then the connector will rename the existing tag.
c. The connector will create a new tag with the custom name if neither a. nor b. apply.
The filter toolbar (shown in the preceding image as a dark gray, horizontal strip) above the list of tag
names shows information about your tag name configuration.
With a PI Server selected, the filter toolbar will show the following:
• If you have checked names against the selected PI Server:
• How many tags the connector is collecting

• How many new tags will be created on the PI Server

• How many existing tags will be reused
• How many existing tags will be renamed to the custom name
• How many are in error (duplicate name, or illegal character)
• How many point type mismatch values are present
• If you have not checked names against the selected PI Server:
• How many tags the connector is collecting
• How many are in error
You can use the drop-down list to filter the table view to display only rows in a particular state.

View Summary
In the View Summary tab, you can review the data for the PI tags selected as well as the selection rules and a

© 2015-2025 AVEVA Group Limited and its subsidiaries. All rights reserved. Page 11
 PI Connector Administration
Data source configuration

comprehensive list of PI Tag Names.

Selected Items

Select the Selected Items button to view a list of the data objects you have chosen to collect. To view the tags
associated with the objects, open the list by selecting the arrow next to the appropriate object. The list displays
the tag, a description of the tag, and the tag type.

Selection Rules

Select the Selection Rules button to view all rules and queries associated with the objects selected.

© 2015-2025 AVEVA Group Limited and its subsidiaries. All rights reserved. Page 12
 PI Connector Administration
Data source configuration

Tag Names

Select the Tag Names button to view a comprehensive list of tags associated with the items selected.

© 2015-2025 AVEVA Group Limited and its subsidiaries. All rights reserved. Page 13
 PI Connector Administration
Data source configuration

Before saving the collection data, select an option for handling future changes to the data source structure.

For both options, when the data source structure changes, the existing data-selection query runs, and any new
elements and assets that are found within the query are automatically added.

• Notify me so I can specify what content to include and exclude: If this option is selected, when new assets
are discovered, the notification count in the upper-right area of the screen updates. From any page in PI Data
Collection Manager, select the notification count to view notifications, and then select the notification to go
to the data-selection screen, where you can update your data-selection queries as needed.
• Use these selections as rules to automatically update destinations: As with the previous option, when the
data source structure changes, the existing data-selection query runs, and any new elements and assets that
are found within the query are automatically added. However, no notifications are posted, so you must
manually check the structure for changes.
Note: The only way to ensure that all new assets are always automatically added is to select the top root
element in the hierarchy.

© 2015-2025 AVEVA Group Limited and its subsidiaries. All rights reserved. Page 14
 ™
AVEVA Group Limited Tel +44 (0)1223 556655
High Cross
Madingley Road www.aveva.com
Cambridge
CB3 0HB
UK To find your local AVEVA office, visit www.aveva.com/offices

AVEVA believes the information in this publication is correct as of its publication date. As part of continued product development, such information is subject to
change without prior notice and is related to the current software release. AVEVA is not responsible for any inadvertent errors. All product names mentioned are
the trademarks of their respective holders.