SetLineCompression Method

SetLineCompression is a method for a Trend Invoke method action.

Purpose: SetLineCompression

Advanced Configuration: SetLineCompression

Historian compression line additional values.

Purpose: SetLineCompression

To set the compression specifications for a particular Line ID.

Advanced Configuration: SetLineCompression

Click Advanced on the Action tab of the Procedure Information dialog box.

The Edit Method dialog box opens for the SetLineCompression method

Configuration is as follows.

Field

Description

Method name

Name of the selected method.

Note: Another method can be selected from the drop-down list.

Method result

(Optional) Setpoint that contains the status value.

 

Boolean

Boolean

 

Structure Type

BOOL

 

Allowed

Device or global Point ID.

Parameters

LineID

String that identifies the line ID whose display parameters you want to change.

 

Type

Expression or point ID that evaluates to one of the following numeric values:

 

 

 

Value

Trending will plot the:

 

 

 

 

0

Not do any compression.

 

 

 

 

1

Average of the values in the group.

 

 

 

 

2

First data point in the group.

 

 

 

 

3

Last data point in the group.

 

 

 

 

4

Data point from the group with the minimum value.

 

 

 

 

5

Plot the data point from the group with the maximum value.

If you are using compression, Trending automatically determines the group size.

 

 

 

 

6

Average of the values in the group, using server side compression.

 

 

 

 

7

First data point in the group, using server side compression.

 

 

 

 

8

Last data point in the group, using server side compression.

 

 

 

 

9

Data point from the group with the minimum value, using server side compression.

 

 

 

 

10

Data point from the group with the maximum value, using server side compression.

 

 

The following values are available only for Historian lines.

 

 

 

 

11

Lab value

 

 

 

 

12

Average value

 

 

 

 

13

Trend

 

 

 

 

14

Interpolated

 

 

 

 

15

Raw standard deviation

 

 

 

 

16

Standard deviation

 

 

 

 

17

Count

 

 

 

 

18

Total

 

 

 

 

19

Raw total value

 

Resolution

Number of time units that should be used for each group of data.

(For Historian lines only) the Resolution value does the following.

 

 

  0

The Default Sampling Interval will be enabled for that line.

 

 

>0

(Greater than 0) Trending checks to see if the Default Sample Interval is enabled for the line; if the Default Sample Interval is enabled, Trending:

Disables the Default Sample Interval.

This enables Sample Interval.

Uses the value entered for the Resolution parameter as the number of time units.

 

Units

Unit of time to be used.

 

 

 

Enter

For

 

 

 

 

0

Seconds

 

 

 

 

1

Minutes

 

 

 

 

2

Hours

 

 

 

 

 

 

More information

Option 5.2.3. Retrieval mode and sample interval for Historian lines.

List of line display methods.

All Trend methods.