Calculation Functions 
PI DataLink User Guide 
97 
A
RGUMENTS
Argument 
Explanation  
tagname (string) 
The tag name or names matching the desired PI points for calculation 
stime (string) 
The start time for the range of calculation (in PI time format) 
etime (string) 
The end time (in PI time format)   
mode (string) 
The type of calculation to be used to compute point values 
cfactor (number) 
The time unit of flow for the source tag, required for Total calculations 
outcode (integer) 
An output code, 0-7, and not 3  
PIServer (string) 
The target PI server  
R
ETURNS
The output code (page 82) argument affects the output as follows: 
• 
If the outcode is 0, only the calculated value is returned.  
• 
If the outcode is 1, the following applies: 
Mode 
Column 1  
Column 2 
Column 3  
Total 
Total value  
Minimum 
Time of min. Value  
Minimum value 
Maximum 
Time of max. Value  
Maximum value 
Stdev 
Stdev. Value  
Range 
Time of min. Value  
Time of max. value 
Range value  
Average 
Average value  
Count 
Count value  
Mean 
Mean value  
• 
An output code of 2 transposes the output array that results from an output code of 1, and 
results are returned in rows instead of in columns. 
• 
Outcode of 3 is not used.  
• 
If the outcode is 4, the percent good is returned to the right of the value cell. 
• 
If the outcode is 5, the following applies: 
Mode 
Column 1  
Column 2 
Column 3  
Column 4 
Total  
Total value 
Percent good  
Minimum 
Time of min. value  
Minimum value 
Percent good  
Maximum  
Time of max. value 
Maximum value  
Percent good 
Stdev 
Stdev. value  
Percent good 
Range  
Time of min. value 
Time of max. value  
Range value 
Percent good  
Average 
Average value  
Percent good 
Count  
Count value 
Percent good  
Find and replace text in pdf - search text inside PDF file in C#.net, ASP.NET, MVC, Ajax, WinForms, WPF
Learn how to search text in PDF document and obtain text content and location information
pdf find highlighted text; find and replace text in pdf file
Find and replace text in pdf - VB.NET PDF Text Search Library: search text inside PDF file in vb.net, ASP.NET, MVC, Ajax, WinForms, WPF
Learn How to Search Text in PDF Document and Obtain Text Content and Location Information in VB.NET application
select text pdf file; search text in pdf using java
PI DataLink Function Reference 
98 
Mode 
Column 1  
Column 2 
Column 3  
Column 4 
Mean 
Mean value  
Percent good 
• 
An output code of 6 transposes the output array that results from an output code of 4, and 
results are returned in rows instead of in columns. 
• 
An output code of 7 transposes the output array that results from an output code of 5, and 
results are returned in rows instead of in columns. 
E
XAMPLE
The following calculates a time-weighted total for the tag cdf144 from yesterday to today 
from the default PI Server: 
=PICalcVal("cdf144","y","t","total",1440,4,) 
The result is multiplied by 1440. The percent good is returned next to the total. 
R
ELATED 
T
OPICS
• 
Calculated Data (page 33) 
PIAdvCalcVal() 
Retrieves a calculated PI point value using the following syntax: 
PIAdvCalcVal(tagname, stime, etime, mode, calcbasis, minpctgood, 
cfactor, outcode, PIServer) 
A
RGUMENTS
Argument 
Explanation  
tagname (string) 
The tag name matching the desired PI point for calculation 
stime (string) 
The start time for the range of calculation (in PI time format)  
etime (string) 
The end time (in PI time format)  
mode (string) 
The type of calculation to be used to compute point values 
calcbasis (string) 
The weighting method used to calculate values 
minpctgood 
(number) 
The minimum percentage of good data required to calculate and 
return a value 
cfactor (number) 
The time unit of flow for the source tag, required for Total calculations 
outcode (integer) 
An output code, either 0, 1, 2, 4, 5, 6, or 7, and not 3 
PIServer (string) 
The target PI server  
R
ETURNS
See specific information for PICalcVal() outcodes (page 96). 
VB.NET PDF replace text library: replace text in PDF content in vb
and ASP.NET webpage. Find and replace text in PDF file in preview without adobe PDF reader component installed. Able to pull text
can't select text in pdf file; search pdf for text
VB.NET PDF File Merge Library: Merge, append PDF files in vb.net
When you have downloaded the RasterEdge Image SDK for .NET, you can unzip the package to find the RasterEdge.Imaging.PDF.dll in the bin folder under the root
select text in pdf; select text in pdf file
Calculation Functions 
PI DataLink User Guide 
99 
E
XAMPLE
The following calculates a time-weighted total for the tag cdf144 from yesterday to today 
from the default PI Server: 
=PIAdvCalcVal("cdf144","y","t","total","time-weighted",50,1,4,) 
The result is multiplied by 1. The minpctgood is 50 percent so result will only be 
displayed if percent good is 50 percent or greater. The percent good is returned next to the 
total. 
R
ELATED 
T
OPICS
• 
Calculated Data (page 33) 
PIAdvCalcFilVal() 
Retrieves a filtered, calculated PI point value using the following syntax: 
PIAdvCalcFilVal(tagname, stime, etime, filtexp, mode, calcbasis, 
sampmode, sampfreq, minpctgood, cfactor, outcode, PIServer) 
A
RGUMENTS
Argument 
Explanation  
tagname (string) 
The tag name or names matching the desired PI points for 
calculation 
stime (string) 
The start time for the range of calculation (in PI time format)  
etime (string) 
The end time (in PI time format)  
filtexp (string) 
The filter expression used to filter results 
mode (string) 
The type of calculation to be used to compute point values 
calcbasis (string) 
The weighting method used to calculate values 
sampmode (string) 
The sampling method used for calculation expressions 
sampfreq (string) 
The frequency used for interpolated sampling 
minpctgood (number) 
The minimum percentage of good data required to calculate and 
return a value 
Cfactor (number) 
The time unit of flow for the source tag, required for Total 
calculations 
outcode (integer) 
An ouput code, either 0, 1, 2, 4, 5, 6, or 7, and not 3 
PIServer (string) 
The target PI server  
R
ETURNS
See specific information for PICalcVal() outcodes (page 96). 
VB.NET PDF File & Page Process Library SDK for vb.net, ASP.NET
document. If you find certain page in your PDF document is unnecessary, you may want to delete this page directly. Moreover, when
convert pdf to searchable text; text searchable pdf file
VB.NET Create PDF Library SDK to convert PDF from other file
Create writable PDF file from text (.txt) file in VB.NET To get this RasterEdge PDF document file creator library the RasterEdge .NET Image SDK and find the PDF
how to select text in pdf and copy; how to select text in pdf image
PI DataLink Function Reference 
100 
E
XAMPLE
The following calculates a time-weighted total for the tag cdf144 from yesterday to today 
during the time periods when tag cdm158 is in Manual from the default PI Server: 
=PIAdvCalcFilVal("cdf144","y","t","'cdm158'=""Manual""","total","t
ime-weighted","pt. compressed","10m",50,1,4,) 
The result is multiplied by 1. Since point compressed is the specified sampling mode, the 
sampling frequency is ignored and the filter expression will be sampled at the compressed 
events of cdf144. The minpctgood is 50 percent so result will only be displayed if 
percent good is 50 percent or greater. The percent good is returned next to the total. 
R
ELATED 
T
OPICS
• 
Calculated Data (page 33) 
• 
filter expression (page 74) 
PIAdvCalcExpVal() 
Retrieves a calculated PI point value based on an expression, using the following syntax: 
PIAdvCalcExpVal(expression, stime, etime, mode, calcbasis, 
sampmode, sampfreq, minpctgood, cfactor, outcode, PIServer) 
A
RGUMENTS
Argument 
Explanation  
expression (string) 
A PI calculation expression 
stime (string) 
The start time for the range of calculation (in PI time format) 
etime (string) 
The end time (in PI time format)  
mode (string) 
The type of calculation to be used to compute point values 
calcbasis (string) 
The weighting method used to calculate values 
sampmode (string) 
The sampling method used for calculation expressions 
sampfreq (string) 
The frequency used for interpolated sampling 
minpctgood (number) 
The minimum percentage of good data required to calculate and 
return a value 
cfactor (number) 
The time unit of flow for the source tag, required for Total 
calculations 
outcode (integer) 
An ouput code, either 0, 1, 2, 4, 5, 6, or 7, and not 3 
PIServer (string) 
The target PI server  
R
ETURNS
See specific information for PICalcVal() outcodes (page 96). 
C# HTML5 PDF Viewer SDK deployment on Visual Studio .NET
C#.NET rotate PDF pages, C#.NET search text in PDF, C# Unzip the download package and you can find a project Once done debugging with x86 dlls, replace the x86
search pdf for text in multiple files; how to select text in a pdf
VB.NET PDF - Deploy VB.NET HTML5 PDF Viewer on Visual Studio.NET
C#.NET rotate PDF pages, C#.NET search text in PDF, C# Unzip the download package and you can find a project Once done debugging with x86 dlls, replace the x86
search text in pdf image; pdf searchable text
Calculation Functions 
PI DataLink User Guide 
101 
E
XAMPLE
The following calculates a time-weighted total for the expression 'cdf144'+'cdt158' from 
yesterday to today from the default PI Server: 
=PIAdvCalcExpVal("'cdf144'+'cdt158'","y","t","total","time-
weighted","compressed","10m",50,1,4,) 
The result is multiplied by 1. Since compressed is the specified sampling mode, the sampling 
frequency is ignored and the expression will be sampled at the combined compressed events 
of cdf144 and cdt158. The minpctgood is 50 percent so result will only be displayed if 
percent good is 50 percent or greater. The percent good is returned next to the total. 
R
ELATED 
T
OPICS
• 
Calculated Data (page 33) 
• 
PI calculation expression (page 74)  
PIAdvCalcExpFilVal() 
Retrieves a filtered, calculated PI point value based on an expression, using the following 
syntax: 
PIAdvCalcExpFilVal(expression, stime, etime, filtexp, mode, 
calcbasis, sampmode, sampfreq, minpctgood, cfactor, outcode, 
PIServer) 
A
RGUMENTS
Argument 
Explanation  
expression (string) 
A PI calculation expression  
stime (string) 
The start time for the range of calculation (in PI time format)  
etime (string) 
The end time (in PI time format)   
filtexp (string) 
The filter expression used to filter results 
mode (string) 
The type of calculation to be used to compute point values 
calcbasis (string) 
The weighting method used to calculate values 
sampmode (string) 
The sampling method used for calculation expressions 
sampfreq (string) 
The frequency used for interpolated sampling  
minpctgood (number) 
The minimum percentage of good data required to calculate and 
return a value 
cfactor (number) 
The time unit of flow for the source tag, required for Total 
calculations 
outcode (integer) 
An ouput code, either 0, 1, 2, 4, 5, 6, or 7, and not 3 
PIServer (string) 
The target PI server  
R
ETURNS
See specific information for PICalcVal() outcodes (page 96). 
C# PDF File Permission Library: add, remove, update PDF file
Text: Replace Text in PDF. Image: Insert Image to PDF. Image: Remove read PDF, VB.NET convert PDF to text, VB.NET the following code table, you will find a piece
find text in pdf image; text searchable pdf
VB.NET PDF File Permission Library: add, remove, update PDF file
Text to PDF. Text: Delete Text from PDF. Text: Replace Text in PDF. NET rotate PDF pages, C#.NET search text in PDF In the following code table, you will find a VB
convert pdf to word searchable text; how to select all text in pdf
PI DataLink Function Reference 
102 
E
XAMPLE
The following calculates a time-weighted total for the expression 'cdf144'+'cdt158' when 
'productid' = "Product2" from yesterday to today from the default PI Server: 
=PIAdvCalcExpFilVal("'cdf144'+'cdt158'","y","t","'productid'="Prod
uct2"","total","time-weighted","compressed","10m",50,1,4,) 
The result is multiplied by 1. Since compressed is the specified sampling mode, the sampling 
frequency is ignored and the expression will be sampled at the combined compressed events 
of cdf144 and cdt158. The minpctgood is 50 percent so result will only be displayed if 
percent good is 50 percent or greater. The percent good is returned next to the total. 
R
ELATED 
T
OPICS
• 
Calculated Data (page 33) 
• 
PI calculation expression (page 74)  
• 
filter expression (page 74) 
PICalcDat() 
Retrieves calculated PI point values using the following syntax: 
PICalcDat(tagname, stime, etime, interval, mode, cfactor, outcode, 
PIServer) 
Note: PICalcDat() is generated only by the Calculated Data dialog box in XP-2003 
versions. 2007 versions use PIAdvCalcDat(). 
A
RGUMENTS
Argument 
Explanation  
tagname (string) 
The tag name or names matching the desired PI points for 
calculation 
stime (string) 
The start time for the range of calculation (in PI time format) 
etime (string) 
The end time (in PI time format)  
interval (string) 
The interval between calculated values (in PI time format) 
mode (string) 
The type of calculation to be used to compute point values 
cfactor (number) 
The time unit of flow for the source tag, required for Total calculations 
outcode (integer) 
An ouput code, 0-7  
PIServer (string) 
The target PI server   
R
ETURNS
The output code (page 82) argument affects the output as follows: 
• 
0 produces calculated values along a column 
• 
1 produces timestamps and values along 2 columns  
• 
2 produces calculated values along a row  
Calculation Functions 
PI DataLink User Guide 
103 
• 
3 produces timestamps and values along 2 rows  
• 
4 produces values and percent good along 2 columns  
• 
5 produces timestamps, values, and percent good along 3 columns  
• 
6 produces values and percent good along 2 rows  
• 
7 produces timestamps, values, and percent good along 3 rows 
E
XAMPLE
The following retrieves totals for the tag located in cell B1, from midnight yesterday to 
midnight today at 3-hour intervals from the default PI Server: 
=PICalcDat(b1,"y","t","3h","total",24,1,) 
Timestamps are also returned. The values are multiplied by 24 before they are displayed in 
the spreadsheet. 
R
ELATED 
T
OPICS
• 
Calculated Data (page 33) 
PIAdvCalcDat() 
Retrieves calculated PI point values using the following syntax: 
PIAdvCalcDat(tagname, stime, etime, interval, mode, calcbasis, 
minpctgood, cfactor, outcode, PIServer) 
A
RGUMENTS
Argument 
Explanation  
tagname (string) 
The tag name or names matching the desired PI points for 
calculation 
stime (string) 
The start time for the range of calculation (in PI time format) 
etime (string) 
The end time (in PI time format)   
interval (string) 
The interval between calculated values (in PI time format)  
mode (string) 
The type of calculation to be used to compute point values 
calcbasis (string) 
The weighting method used to calculate values 
minpctgood 
(number) 
The minimum percentage of good data required to calculate and 
return a value 
cfactor (number) 
The time unit of flow for the source tag, required for Total calculations  
outcode (integer) 
An ouput code, 0-7  
PIServer (string) 
The target PI server  
R
ETURNS
See specific information for PICalcDat() outcodes (page 102). 
PI DataLink Function Reference 
104 
E
XAMPLE
The following retrieves totals for the tag cdf144, from midnight yesterday to midnight 
today at three-hour intervals from the default PI Server: 
=PIAdvCalcDat("cdf144","y","t","3h","total","time-
weighted",50,1,4,) 
The result is multiplied by 1. The minpctgood is 50 percent so result will only be 
displayed if percent good is 50 percent or greater. The percent good is returned next to the 
total. 
R
ELATED 
T
OPICS
• 
Calculated Data (page 33) 
PIAdvCalcFilDat() 
Retrieves filtered, calculated PI point values using the following syntax: 
PIAdvCalcFilDat(tagname, stime, etime, interval, filtexp, mode, 
calcbasis, sampmode, sampfreq, minpctgood, cfactor, outcode, 
PIServer) 
A
RGUMENTS
Argument 
Explanation  
tagname (string) 
The tag name or names matching the desired PI points for 
calculation 
stime (string) 
The start time for the range of calculation (in PI time format)  
etime (string) 
The end time (in PI time format)  
interval (string) 
The interval between calculated values (in PI time format) 
filtexp (string) 
The filter expression used to filter results 
mode (string) 
The type of calculation to be used to compute point values  
calcbasis (string) 
The weighting method used to calculate values 
sampmode (string) 
The sampling method used for calculation expressions 
sampfreq (string) 
The frequency used for interpolated sampling 
minpctgood (number) 
The minimum percentage of good data required to calculate and 
return a value 
cfactor (number) 
The time unit of flow for the source tag, required for Total 
calculations 
outcode (integer) 
An ouput code, 0-7  
PIServer (string) 
The target PI server  
R
ETURNS
See specific information for PICalcDat() outcodes (page 102). 
Calculation Functions 
PI DataLink User Guide 
105 
E
XAMPLE
The following retrieves totals for the tag cdf144, from midnight yesterday to midnight 
today at 3-hour intervals during the time periods when tag cdf144 is in Manual from the 
default PI Server: 
=PIAdvCalcFilDat("cdf144","y","t","3h","'cdm158'=""Manual""","tota
l","time-weighted","pt. compressed","10m",50,1,4,) 
The result is multiplied by 1. Since point compressed is the specified sampling mode, the 
sampling frequency is ignored and the filter expression will be sampled at the compressed 
events of cdf144. The percent good is returned next to the total. 
R
ELATED 
T
OPICS
• 
Calculated Data (page 33) 
• 
filter expression (page 74) 
PIAdvCalcExpDat() 
Retrieves calculated PI point values based on an expression, using the following syntax: 
PIAdvCalcExpDat(expression, stime, etime, interval, mode, 
calcbasis, sampmode, sampfreq, minpctgood, cfactor, outcode, 
PIServer) 
A
RGUMENTS
Argument 
Explanation  
expression (string) 
A PI calculation expression 
stime (string) 
The start time for the range of calculation (in PI time format)  
etime (string) 
The end time (in PI time format)   
interval (string) 
The interval between calculated values (in PI time format)  
mode (string) 
The type of calculation to be used to compute point values 
calcbasis (string) 
The weighting method used to calculate values 
sampmode (string) 
The sampling method used for calculation expressions 
sampfreq (string) 
The frequency used for interpolated sampling 
minpctgood (number) 
The minimum percentage of good data required to calculate and 
return a value 
cfactor (number) 
The time unit of flow for the source tag, required for Total 
calculations  
outcode (integer) 
An ouput code, either 0, 1, 2, 4, 5, 6, or 7, and not 3 
PIServer (string) 
The target PI server  
R
ETURNS
See specific information for PICalcDat() outcodes (page 102). 
PI DataLink Function Reference 
106 
E
XAMPLE
The following retrieves totals for the expression 'cdf144'+'cdt158', from midnight 
yesterday to midnight today at 3-hour intervals from the default PI Server: 
=PIAdvCalcExpDat("'cdf144'+'cdt158'","y","t","3h","total","time-
weighted","compressed", "10m",50,1,4,) 
The result is multiplied by 1. Since compressed is the specified sampling mode, the sampling 
frequency is ignored and the expression will be sampled at the combined compressed events 
of cdf144 and cdt158. The minpctgood is 50 percent so result will only be displayed if 
percent good is 50 percent or greater. The percent good is returned next to the total. 
R
ELATED 
T
OPICS
• 
Calculated Data (page 33) 
• 
PI calculation expression (page 74)  
PIAdvCalcExpFilDat() 
Retrieves filtered, calculated PI point values based on an expression, using the following 
syntax: 
PIAdvCalcExpFilDat(expression, stime, etime, interval, filtexp, 
mode, calcbasis, sampmode, sampfreq, minpctgood, cfactor, outcode, 
PIServer) 
A
RGUMENTS
Argument 
Explanation  
expression (string) 
A PI calculation expression 
stime (string) 
The start time for the range of calculation (in PI time format)  
etime (string) 
The end time (in PI time format)    
interval (string) 
The interval between calculated values (in PI time format) 
filtexp (string) 
The filter expression used to filter results 
mode (string) 
The type of calculation to be used to compute point values 
calcbasis (string) 
The weighting method used to calculate values 
sampmode (string) 
The sampling method used for calculation expressions 
sampfreq (string) 
The frequency used for interpolated sampling 
minpctgood (number) 
The minimum percentage of good data required to calculate and 
return a value 
cfactor (number) 
The time unit of flow for the source tag, required for Total 
calculations 
outcode (integer) 
An ouput code, either 0, 1, 2, 4, 5, 6, or 7, and not 3 
PIServer (string) 
The target PI server  
R
ETURNS
See specific information for PICalcDat() outcodes (page 102). 
Documents you may be interested
Documents you may be interested