JDBC TagDefinition

Using the JDBC TagDefinition activity you can create and modify tag using a set of attributes provided as input.

Note: The time zone of the data retrieved from the OSIsoft PI Data Archive server is the time zone of the OSIsoft PI Data Archive server.

General

On the General tab, you can specify the name of the activity in the process, establish a connection to the PI JDBC server, select the type of operation you want to perform, specify and export the XSD schema.

The following table lists the fields on the General tab of the JDBC TagDefinition activity:

Field	Module Property?	Visual Diff?	Description
Name	No	Yes	A unique name of the activity in a process.
Server Connection	Yes	Yes	The PI JDBC shared resource selected to connect to a PI JDBC server. Click the icon to select an OSIsoft PI System JDBC connection resource. If no matching PI JDBC connection resource is found, click Create Shared Resource to create one.
Operation	No	Yes	The type of operation you want to perform: create: to create tags modify: to modify tags

Field

Module Property?

Visual Diff?

Description

Name

Yes

A unique name of the activity in a process.

Server Connection

Yes

The PI JDBC shared resource selected to connect to a PI JDBC server.

Click the icon to select an OSIsoft PI System JDBC connection resource. If no matching PI JDBC connection resource is found, click Create Shared Resource to create one.

Operation

Yes

The type of operation you want to perform:

create: to create tags
modify: to modify tags

Description

On the Description tab, you can type a short description for the JDBC TagDefinition activity.

Input

On the Input tab, you can specify the tag name along with the list of attributes.

The input items are different depending on the operation type you select on the General tab.

The following input item is available for create and modify operation:
Input Item	Data Type	Required	Description
tagList	Complex	Yes	The list of tag definitions that you want to create or modify.

The following input items are available under tagList:
Input Item	Data Type	Required	Description
pointName	String	Yes	The name of the tag on the PI Data Archive server.
pointClass	String	Yes	The attribute that specifies point class from the point classes that belong to the PI Data Archive server.
pointType	String	Yes	The attribute that specifies the data type for the values that a point stores. Supported point types include: Digital, Timestamp, Float64, Float32, Float16, Int32, Int16, String, and Blob.
pointSource	String	Yes	The attribute that identifies the source of data for a PI point.
descriptor	String	No	The description of the PI tag.
extendedDescription	String	No	Optional extended description for the PI point.
digitalSet	String	No	The name of the digital set. This attribute is only relevant when the pointType attribute is Digital .
displayDigits	Integer	No	The attribute that determines the display precision of PI point values.
engineeringUnits	String	No	The default unit of measurement for the PI point.
sourceTag	String	No	Reference to another PI point. Data stream of this PI point is used as the source for the given PI point.
archiving	Integer	No	The attribute that enables or disables values archiving. Supported values are 0 and 1.
scan	Integer	No	The attribute that enables or disables interface scanning. Supported values are 0 and 1.
compressing	Integer	No	The attribute that determines whether snapshot events are selected to be sent to the archive file for storage. Supported values are 0 and 1.
zero	Boolean	No	The lowest possible value of a PI point.
span	Boolean	No	The range between the maximum and minimum values for a point. The sum of zero and span determines the highest possible value.
excdev	Boolean	No	Exception deviation, the set of values that define a deadband used for exception reporting. If this attribute is used, the excdevpercent attribute is recalculated.
excdevpercent	Boolean	No	Percentage of exception deviation. If this attribute is used, the excdev attribute is recalculated.
compdev	Boolean	No	Compression deviation, the compression algorithm used to reduce the data flow from the interfaces to the PI Data Archive server. If this attribute is used, the compdevpercent attribute is recalculated.
compdevpercent	Boolean	No	Percentage of compression deviation. If this attribute is used, the compdev attribute is recalculated.

Output

On the Output tab, you can find the output results structured in the schema you specify on the General tab.

Operation	Reference
create	create: Output Items
modify	modify: Output Items

Fault

On the Fault tab, you can find the error messages and error codes of the JDBC TagDefinition activity. For more information about errors, see Error Codes.

The following table lists the error schema elements on the Fault tab:

Element Name	Data Type	Description
msg	String	Displays the error message.
msgCode	String	Displays the error code.