Plant Database Function Details

The following is a list of the standard functions available from the Plant Database connector, along with a description of the purpose of each function.

The parameter values listed here are the parameters that have configurable defaults. In some cases, additional parameters are available and can be used when linking objects (that is, the parameters will appear on the Link Property to dialog box). For more information on using parameters to link objects, see Parameter Connections.

For more information on the columns returned by the functions, refer to your Plant Applications documentation.

NOTE: This list provides information for the default state of the functions only.

Function

Description

Parameter Values

Available Columns

List Departments

Retrieves a list of departments.

none

Dept. Description

Dept. Id

List Lines

Retrieves a list of lines.

Dept. Id

Line Description

Line Id

List Units

Retrieves a list of units.

Line Id

Unit Description

Unit Id

List Variable Groups

Retrieves a list of variable groups.

Unit Id

Variable Group Description

Group Id

List Variables

Retrieves a list of variables.

Unit

Variable Description

Variable Id

List Schedule

Retrieves a list of shifts.

None

Shift Description

List Crew

Retrieves a list of crews.

None

Crew Description

List Products

Retrieves a list of products.

None

Product Description

Product Id

List Reasons

Retrieves a list of reason names.

None

Reason Name

Reason Id

List Reason Trees

Retrieves a list tree names.

None

Tree Name

Tree Name Id

List Spec Limits

Retrieves a list of specification limits.

Specification

Characteristic

Start Date/Time

AS Id

Effective Date

ExpirationDate

Test Frequency

Defined By

Specification Id

Deviation From

Characteristic Id

Is Defined

Is OverRideable

Is Deviation

Is Lower Rejectable

Is Upper Rejectable

Lower Warning

Lower Reject

Lower Entry

Upper User

Target

Lower User

Upper Entry

Upper Reject

Upper Warning

Data Type Id

List Properties

Retrieves a list of properties.

None

Property Description

Property Id

List Specification Variables

Retrieves a list of specification variables.

Property

Specification Description

Specification Id

List Characteristics

Retrieves a list of characteristics.

Property

Char Description

Char Id

List Product Attributes

Retrieves attributes associated with a given product.

Product

Product Id

Product Alias

Use Manufacturing Product

Product Family Id

Is Active Product

Is Sales Product

Is Manufacturing Product

Tag

External Link

Product Code

Product Change Esignature

Event Esignature Level

Extended Info

Product Description

List Schedule Statuses

Retrieves a list of schedule statuses.

None

Status Description

Status Id

List Data Types (phrases)

Retrieves a list of customer enumerations/values.

None

Data Type Phrase Id

Data Type Name

Phrase Name

Phrase Order

List Production Statuses

Retrieves product statuses and associated IDs.

None

Product Status Description

Product Status Id

List Product Families

Retrieves a list of product families.

None

Product Family Name

Product Family Id

List Customers

Retrieves a list of customers.

None

Customer Id

Customer Code

Customer Name

Consignee Code

Consignee Name

Customer Type

Is Active

Contact Name

Contact Phone

Address1

Address2

Address3

Address4

City

County

State

Country

ZIP

Customer General 1

Customer General 2

Customer General 3

Customer General 4

Customer General 5

Extended Info

List Customer Orders

Retrieves a list of customer orders.

None

Order Id

Is Active

Entered Date

Forecast Mfg Date

Forecast Ship Date

Actual Mfg Date

Actual Ship Date

Consignee Name

Total Line Items

Customer Name

Order General 1

Order General 2

Order General 3

Order General 4

Order General 5

Order Instructions

Order Type

Order Status

Customer Order Number

Plant Order Number

Corporate Order Number

Extended Info

List Customer Shipments

Retrieves a list of customer shipments.

None

Shipment Id

Shipment Number

Shipment Date

Arrival Date

Carrier Code

Carrier Type

List Line Properties

Retrieves a list of production lines.

None

Production Line Id

Department Name

Line Name

Extended Info

List Unit Properties

Retrieves a list of departments.

None

Production Unit Id

Department Name

Unit Name

Line Name

Master Unit Name

Is Master Unit

Has Production Events

Extended Info

List Faults

Retrieves a list of faults.

None

TE Fault Id

Unit Id

Unit

TE Fault Name

TE Fault Value

List Execution Paths

Retrieves a list of execution paths.

None

Path Code

Path Id

List Process Orders

Retrieves a list of process orders.

None

Process Order

Product Code

Forecast Start Date

Prod Plan Id

Get OEE Percent

Retrieves OEE percent for all units.

Start Date/Time

End Date/Time

Unit Name

OEE %

Get OEE Summary

Retrieves a summary of waste, down time, etc. for all units.

Start Date/Time

End Date/Time

Unit Name

Rate %

Quality Rate

Available Rate

OEE %

Get Net Rate

Retrieves net operating rate for each unit.

Start Time

End Time

Unit Name

Net Rate

Units

Get Top 10 Waste Distribution

Retrieves details of the top ten largest waste events in the given time period.

Start Date/Time

End Date/Time

Unit

Total

MATR

MABF

% Total

Number of Events

Get Rate Percent

Retrieves operating percentage for all units.

Start Date/Time

End Date/Time

Unit Name

Rate %

Get Top 10 Down Time Distribution

Retrieves details of the ten down time events that consumed the most time in the given time period.

Start Date/Time

End Date/Time

Unit

Total

MTTR

MTBF

% Total

Events

Get Process Order History

Retrieves audit for process order.

Prod Plan Id

User

Change Time

Trans Type

Process Order

Status

Product Desc

Product Code

Block Number

Quantity

Forecast Start

Forecast End

Product Rate

Type

Source Order

User General 1

User General 2

User General 3

Info

Get Process Order Details

Retrieves a detailed audit for process order.

Start Time

End Time

Path Code

Prod Plan Id

Implied Sequence

Path Id

Line Id

Unit_Id

Process Order

Product Id

Prod PlanStatus Id

Control Type

Predicted Remaining Quantity

Actual Good Quantity

Forecast Quantity

Predicted Remaining Duration

Estimated Remaining Date

Actual Start Time

Forecast Start Date

Estimated End Duration

Estimated End Date

Actual End Time

Forecast End Date

Alarm Count

Late Items

Actual Running Time

Actual Down Time

Predicted Total Duration

Actual Good Items

Actual Bad Items

Actual Bad Quantity

Parent Prod Plan Id

Children

Source Prod Plan Id

Sequences

User General 1

User General 2

User General 3

Extended Info

Block Number

Production Rate

Prod Plan Type Id

Adjusted Quantity

Parent Process Order

Source Process Order

Children Count

List Products by Unit

Retrieves a list of products for a given unit.

Unit Id

Product Description

Product Id

List Reason Level Data

Retrieves a list of reasons for a given event type and level.

Event Type

Required Level (1 - 4)

Tree Id (Internal)

Parent Id (Internal)

NOTE: Tree Id and Parent Id are for internal use only do not enter default values for these parameters.

Reason

Reason Id

List Action Level Data

Retrieves a list of actions for a given event type and level.

Event Type

Required Level (1 - 4)

Tree Id (Internal)

Parent Id (Internal)

NOTE: Tree Id and Parent Id are for internal use only do not enter default values for these parameters.

Action (Action-based Reason Name)

Action Id

List Production Event Attributes

Retrieves event attributes.

Event Number

Primary Event Number

Event Id

Production Unit

Start Date/Time

TimeStamp

Event Status

Entered On

Original Product

Applied Product

Alternate Event Number

Event Type

Initial Dimension X

Initial Dimension Y

Initial Dimension Z

Initial Dimension A

Final Dimension X

Final Dimension Y

Final Dimension Z

Final Dimension A

Customer Order Number

Plant Order Number

Shipment Number

Orientation X

Orientation Y

Orientation Z

Extended Info

Event Conformance

Testing Prct Complete

Approver User

User Signoff

Username

Second User

User Reason

Approver Reason

List Faults (Unit)

Retrieves a list of faults per unit.

Unit

TE Fault Id

Reason Level 1

Reason Level 2

Unit Id

Reason Level 4

Source Unit Id

Reason Level 2

TE Fault Value

TE Fault Name

Event Reason Tree Data Id

Get OEE Percent (Unit)

Retrieves OEE percent for each unit.

Unit

Start Date/Time

End Date/Time

Unit Name

OEE %

Get Down Time Percent

Retrieves the down time percentage for a given unit.

Unit

Start Date/Time

End Date/Time

Down Time Percent

Get OEE Details

Retrieves OEE details (waste, down time, etc.) for a given unit.

Unit

Start Date/Time

End Date/Time

Unit Name

Rate %

Waste Amount

Quality Rate

Down Time

Available Rate

OEE %

Get Down Time Details

Retrieves down time detail for a given unit.

Start Date/Time

End Date/Time

Unit

Product

Group

Property

Characteristic

Detail Id

Start Date/Time

End Date/Time

Duration

Uptime

Product Code

Unit

Location

Reason1

Reason2

Reason3

Reason4

Action1

Action2

Action3

Action4

Fault

Status

Crew Description

Shift Description

Get Down Time Summary

Retrieves down time summary data for a given unit.

Start Date/Time

End Date/Time

Unit

Product

Group

Property

Characteristic

Reason Name

Number of Occurrences

Total Reason Minutes

Average Reason Minutes

Total Downtime Minutes

Average Uptime Minutes

Total Uptime Minutes

Total Operating Minutes

Total Product Operating Minutes

Get Waste Percent

Retrieves the percentage of waste for a given unit.

Unit

Start Date/Time

End Date/Time

Waste Percent

Get Waste Details

Retrieves event level waste details

Start Date/Time

End Date/Time

Unit

Product

Group

Property

Characteristic

TimeStamp

Waste TimeStamp

Amount

Measurement

Type

Event_Number

Location

Reason1

Reason2

Reason3

Reason4

Action1

Action2

Action3

Action4

Crew

Shift

Get Waste Summary

Retrieves waste summary information for a given unit

Start Date/Time

End Date/Time

Unit

Product

Group

Property

Characteristic

Reason Name

Number of Occurrences

Total Reason Units

Average Reason Units

Total Waste Units

Total Operating Units

Get Production Counts

Retrieves a summary of production counts for a given unit.

Unit

Start Time

End Time

Is Being Made Now Flag

Product Code

Production Items

Production Amount

Production Engineering Units

Conformance Percent

Rate Percent

Run Time

Downtime Percent

Waste Percent

Product ID

Unit List

Get Down Time Statistics

Retrieves down time details for a given unit.

Unit

Start Date/Time

End Date/Time

Unit

Total

MTTR

MTBF

% Total

Events

Get Production Rate

Retrieves the production rate for a given unit.

Unit

Start Date/Time

End Date/Time

Unit Name

Production Rate

Eng Units

Get Top 10 Waste By Unit

Retrieves details of the top ten largest waste events in the given time period and for a given unit.

Unit

Start Date/Time

End Date/Time

Unit

Total

MATR

MABF

% Total

Events

Get Rate Percent (Unit)

Retrieves operating percentage for each unit.

Unit

Start Date/Time

End Date/Time

Unit Name

Rate %

Get Top 10 Down Time By Unit

Retrieves details of the ten down time events that consumed the most time in the given time period and for a given unit.

Unit

Start Date/Time

End Date/Time

Unit

Total

MTTR

MTBF

% Total

Events

Get Alarm Counts

Retrieves alarm counts for a given unit.

Unit

Start Date/Time

End Date/Time

High Count

Medium Count

Low Count

Get Last Run

Retrieves details of the last run for a given unit.

Unit

Product

Group

Property

Characteristic

Product code

RSum_Id

Start Date/Time

End Date/Time

Duration

In Warning

In Limit

Conf. Index

Unit Id

Product Id

Get Conformance Percent

Retrieves conformance information and provides ratios of warning limits/targets to actual results.

Master Unit

Variable Id List

Start Date/Time

End Date/Time

Product Id List

Include Applied Products

Include Broke Events

Product Code

Variable Name

% Lower Reject

% Lower Control

% Control

% Upper Control

% Upper Reject

% Coeff Var Mean

% Coeff Var Target

Number of Samples

Get Conformance Test

Retrieves conformance test information such as the total number of results, total number of events, and the ratio between the results and events totals.

Master Unit

Variable Id List

Start Date/Time

End Date/Time

Product Id List

Include Applied Products

Include Broke Events

Product Code

Variable Name

Std Dev Target

% Tested

% Reject

CPK

% Dev Target

Std Dev Mean

Number Tested

CPM

Get Conformance Details

Retrieves all conformance information (Get Conformance Test and Get Conformance Percent combined).

Master Unit

Variable Id List

Start Date/Time

End Date/Time

Product Id List

Include Applied Products

Include Broke Events

Product Code

Variable Name

Lower Reject

Lower Warning

Target

Upper Warning

Upper Reject

% Lower Reject

% Lower Control

% Control

% Upper Control

% Upper Reject

Minimum Value

Maximum Value

Average

% Coeff Var Mean

% Coeff Var Target

Number of Samples

Std Dev Target

% Tested

% Reject

CPK

% Dev Target

Std Dev Mean

Number Tested

CPM

Production Genealogy (Parent)

Retrieves parent information for a given event.

Event Number

Unit

Event Number

Event Id

Start Date/Time

TimeStamp

Production Unit

Event Type

Relationship

Extended Info

Initial Dimension X

Initial Dimension Y

Initial Dimension Z

Initial Dimension A

Final Dimension X

Final Dimension Y

Final Dimension Z

Final Dimension A

Event Component Timestamp

Event Component Start_Time

Event Component Entry On

Event Component User

Event Component Dimension A

Event Component Dimension X

Event Component Dimension Y

Event Component Dimension Z

Event Component Start Coordinate A

Event Component Start Coordinate X

Event Component Start Coordinate Y

Event Component Start Coordinate Z

Production Genealogy (Children)

Retrieves child information for a given event.

Event Number

Unit

Event Number

Event Id

Start Date/Time

TimeStamp

Production Unit

Event Type

Relationship

Extended Info

Initial Dimension X

Initial Dimension Y

Initial Dimension Z

Initial Dimension A

Final Dimension X

Final Dimension Y

Final Dimension Z

Final Dimension A

Event Component Timestamp

Event Component Start_Time

Event Component Entry On

Event Component User

Event Component Dimension A

Event Component Dimension X

Event Component Dimension Y

Event Component Dimension Z

Event Component Start Coordinate A

Event Component Start Coordinate X

Event Component Start Coordinate Y

Event Component Start Coordinate Z

List Variable Spec Limits

Retrieves specification limits for a given variable

Variable

Product

Start Date/Time

VS Id

Effective Date

ExpirationDate

Deviation From

First Exception

Test Frequency

AS Id

Variable Id

Product Id

Is OverRidden

Is Deviation

Is OverRideable

Is Defined

Is Lower Rejectable

Is Upper Rejectable

Lower Warning

Lower Reject

Lower Entry

Upper User

Target

Lower User

Upper Entry

Upper Reject

Upper Warning

Data Type Id

List Variable Attributes

Retrieves attributes for a given variable.

Variable

Variable Id

Variable Description

Engineering Units

Unit Description

Data Type Description

Specification Description

Sampling Interval

Sampling Type

Variable Precision

Event Type

Ds Description

Input Tag

Output Tag

Calculation Name

Calculation Type

Calculation Detail

Rank

External Link

List Test History

Retrieves test details.

Variable

Start Date/Time

End Date/Time

Test Id

TimeStamp

Test Status

Result

Entry On

Entry By User

Get Test Value

Retrieves the current value for the given test variable

Variable

Unit

Test Id

Canceled

Result On

Entry On

Event Id

Variable Id

Entry By

Array Id

Result

Product Id

Get Test Calculation

Retrieves calculated results for a given variable

Variable

Start Date/Time

End Date/Time

Product

Group

Property

Characteristic

Average

Minimum

Maximum

Total

Count of Rows

Standard Deviation

Time of Minimum

Time of Maximum

Get Alarm Summary

Retrieves alarm summary data for a given variable

Variable

Start Date/Time

End Date/Time

Acknowledged

Product

Group

Property

Characteristic

Reason Name

Number of Occurrences

Total Reason Minutes

Average Reason Minutes

Total Alarm Minutes

Total Operating Minutes

Get Alarm Detail

Retrieves alarm detail data for a given variable

Variable

Start Date/Time

End Date/Time

Acknowledged

Product

Group

Property

Characteristic

Alarm Id

Alarm Description

Start Date/Time

End Date/Time

Duration

Location

Product Code

Reason1

Reason2

Reason3

Reason4

Max Result

Min Result

Start Result

End Result

Modified On

Ack On

Action1

Action2

Action3

Action4

Crew

Shift Cutoff

User

Research User

Research Status

Research Open Date

Research Close Date

Data Type Id

Get Test Data By Time

Retrieves test data within a time range for a given variable

Variable

Start Date/Time

End Date/Time

Product

Group

Property

Characteristic

Result On

Entry On

Canceled

Result

Event Id

Event Number

Event Status

Data Type Id

Event Type

Unit Id

Get Test Data By Event

Retrieves test data for a specific variable and event number.

Variable

Event Number

Result On

Entry On

Result

Canceled

Product Code

Event Status

Data Type Id

Get Run Captured Data

Retrieves run data for a given variable

Variable

Start Date/Time

End Date/Time

Product

Group

Property

Characteristic

Timestamp

Product Code

Product Id

Data Set Id

Variable Id

Value

Data Type Id

Get Run Calculations

Retrieves run data calculations for a given variable and calculation type.

Variable

Start Date/Time

End Date/Time

Product

Group

Property

Characteristic

Calculation Type

Average

Minimum

Maximum

Total

Count of Rows

Standard Deviation

Time of Minimum

Time of Maximum

Plant Database Function Details

See Also