Family Field Descriptions
Impact Code Records
Impact Code records store information about the impact of a production loss. This topic provides an alphabetical list and description of the fields that exist for the Impact Code family and appear on the Impact Code datasheet by default.
Field | Data Type | Description | Behavior and Usage |
---|---|---|---|
Code | Character | A short code that represents the impact of the production loss. | This is a required field. A list of baseline Impact Codes can be found here. |
Color | Character | The color that is used to represent the impact code on the Production Data Summary graph. | This field contains a list, which displays all colors that you can assign to the impact code. In the baseline database, colors are not assigned to the baseline Impact Codes. You will need to assign the required colors manually. |
Description | Character | A description of the impact. | You can define this field manually. |
OEE Code Records
OEE Code records store information about the overall effectiveness of a piece of equipment that causes a production loss. The following topics provides an alphabetical list and description of the fields that exist for the OEE Code family and appear on the OEE Code datasheet by default. The information in the table reflects the baseline state and behavior of these fields.
Field | Data Type | Description | Behavior and Usage |
---|---|---|---|
Description | Character | A description of the OEE code. | You can enter a description into this field to define this value manually. |
Is Inactive | Logical | Indicates whether the OEE code is enabled or disabled. | This field does not appear on the datasheet. If this field contains the value True, the code is disabled in the Codes workspace. If the code is disabled, you will not be able to add a child code under it. Also, you will not be able to assign a disabled code to a production loss. If this field contains the value False, the code is enabled and you will be able to use the code throughout PLA. |
OEE Code | Character | A short code that identifies a reason for a loss in equipment efficiency that caused a production loss. | This is a required field. |
Root Code | Character | The parent code of the OEE code. |
This field does not appear on the datasheet. The OEE Metric View uses the value in this field to determine whether an OEE code is an Availability, Performance, or Quality code in the OEE (%) calculation. This field contains the following values, depending on the type of OEE code:
|
Product Records
Product records store basic information about a product in the GE Digital APM system. This topic provides an alphabetical list and description of the fields that exist for the Product family and appear on the Product datasheet. The information in the table reflects the baseline state and behavior of these fields.
Field | Data Type | Description | Behavior and Usage |
---|---|---|---|
Description | Text | A description of the product. | You can define this field manually. |
Name | Character | The name of the product. | You can define this field manually. This field is required and must be unique. |
Production Data Records
Production Data records store information about production values. The following table provides an alphabetical list and description of the fields that exist for the Production Data family and are appear on the Production Data datasheet. The information in the table reflects the baseline state and behavior of these fields.
The baseline Production Data fields are displayed in the grid in the Production Data workspace. If, however, you add fields to the Production Data family and datasheet, those fields will not appear in the Production Data workspace.
This family is enabled for site filtering, which means that records in this family can be assigned to a specific site, and will then only be accessible to users who are assigned to the same site and have the appropriate license and family privileges. For more information, refer to the Site Filtering section of the documentation.
Field | Data Type | Description | Behavior and Usage |
---|---|---|---|
Actual | Number | The amount of product you produced on the period in the Period field. | When the Production Data is created, the value is set to zero (0) by default. It is updated automatically with the Actual value that you enter in the Actual column. |
Losses | Number | The amount of product that you could have produced but did not produce during the period in the Period field. |
When the Production Data is created, this field does not contain any value. It is populated with the sum of the values in the Loss Amount field in all Production Loss records to which the Production Data is linked. This field is disabled. Along with the value in the Margin field in the Production Data, the value in the Losses field is used to calculate the cost of losses, which appears in the Production Summary workspace. |
Max Sustained Capacity | Number | The value against which the Actual value is compared to determine if a loss occurred. |
This value is set by default to the value in the Maximum Sustained Capacity Rate field in the Production Profile that is linked to the Production Plan to which the Production Data is linked. This field is disabled. |
Period | Date | The period for which the production data begins and ends. |
On the Production Data Entry page, the Period column displays the start time and end time, separated by a dash. In the baseline database, this field stores time using the Coordinated Universal Time (UTC) format (i.e., the UTC check box is selected when you view the field properties in the Configuration Manager). This field is disabled. |
Short Range Plan | Number | The adjusted planned production output due to a circumstance that could not have been predicted at the time the plan was created (e.g., natural disaster such as a flood or a hurricane). |
By default, the value is set to the planned production amount, which appears in the <Product Name (<UOM>)> cell in the Plan Details workspace for the associated production plan. You can modify this value. |
Unaccounted Loss | Number |
The value in the Unaccounted Loss column is not stored in the Production Data and is for display purposes only. |
The number that appears in each cell in this column is calculated using the Unaccounted Loss equation. This field is disabled. |
Production Event Code Records
Production Event Code Records store details that represent a type of Production Event. This topic provides an alphabetical list and description of the fields that exist for the Production Event Code family and appear on the baseline Production Event Code datasheet. The information in the table reflects the baseline state and behavior of these fields.
Field | Data Type | Description | Behavior and Usage |
---|---|---|---|
Code | Character | A short code that represents the type of event. | This is a required field. |
Color | Character | The color that is used to represent the production event code on the Production Data Summary graph. |
This field contains a list, which displays all colors that you can assign to the impact code. In the baseline database, colors are not assigned to the baseline Production Event Codes. You will need to assign the required colors manually. |
Description | Character | A description of the type of event. | You can define this field manually. |
Production Event Records
Production Event records store details about an event that results in a reduced production output. This topic provides an alphabetical list and description of fields that exist for the Production Event family and appear in the baseline Production Event datasheet, unless otherwise specified. The information in the table reflects the baseline state and behavior of these fields.
This family is not enabled for site filtering, which means that records in this family can be accessed by any user with the appropriate license and family privileges. For more information, refer to the Site Filtering section of the documentation.
Field | Data Type | Description | Behavior and Usage | ||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
Causing Asset | Character | The equipment or functional location that caused the Production Event. | You can select a value in this field. | ||||||||
Comment | Text | Additional comments about the Production Event. | You can enter a value in this field. | ||||||||
Created By | Character | The user name of the Security User who created the Production Event. | This field is disabled. | ||||||||
Created Date | Date | The date and time when the Production Event was created. | This field is disabled. | ||||||||
Description | Text | A detailed description of the Production Event. | You can enter a value in this field. | ||||||||
Display Event Code | Character | The full path to the event code stored in the Production Event Code field. |
This field stores the value that appears in the Production Event Code box in the datasheet. The field does not appear in the datasheet. | ||||||||
End Date | Date | The date when the Production Event ended. | The values in the Start Date and End Date fields of a Production Event determine whether the Production Event appears in the Production Event drop-down list box when creating or modifying a loss. A Production Event that does not have a value in the End Date field will appear in the Production Event drop-down list box for losses that are associated with any day after the start date of the Production Event. You can enter a value in the field.Note: The value must represent the time zone of the Production Unit. | ||||||||
Event ID | Character | Identifies the Production Event. | This field is automatically populated when you create a Production Event. You can enter a value in the field. The value must be unique. | ||||||||
Headline | Character | A short description of the Production Event. | You can enter a value in this field. | ||||||||
Other Event Costs | Numeric | Costs that are associated with the Production Event and are not recorded in the selected Work History. | You can enter a value in this field. The value is preceded with a currency symbol that is specified in the Currency box in the Settings window for PLA. | ||||||||
Production Event Code | Character | Identifies the type of the Production Event. |
This field contains a list of Production Event Codes that are assigned to the Production Unit you select in the Source Production Unit field.
Note: If the Production Unit field is blank, this field will contain a list of all Production Event Codes. You can select a value in this field. The full path to the selected event code appears in the Production Event Code box in the datasheet. This includes all the categories under which that event code is grouped. For example, if you select Equipment Malfunction, which is grouped under Operational Losses, the Production Event Code box will display the value Operational Losses\Equipment Malfunction. However, the Production Event Code field stores only the selected event code (that is, Equipment Malfunction). | ||||||||
RCA Needed | Character | Indicates whether the Production Event needs a Root Cause Analysis (RCA). | This field is populated by the MI_RCA_Needed System Code Table. The field is required and automatically populated with the value RCA Needed. You can, however, modify the value in the field. Note: For records created before upgrading to V4.3.0.6.0, the default value in this field is No Entry. The value, when it appears in the RCA Needed column, is accompanied by a color-coded symbol whose meaning is provided in the following table:
Note: The RCA Needed column appears in the Production Events table in the PLA Overview page and the Production Events workspace. | ||||||||
Source Production Unit | Character |
Identifies the Production Unit associated with the Production Event. |
This field contains a list of IDs of all available Production Units. The field, however, stores the key of the Production Unit. When you create a Production Event via the Production Data workspace, the field is automatically populated with the Production Unit for which the Production Plan was created. You can, however, modify the value in the field. | ||||||||
Start Date | Date | The date when the Production Event started. | A Production Event that does not have a value in the Start Date field will appear in the Production Event drop-down list box for losses that are associated with any day before the end date of the Production Event. The field is automatically populated with the current date and time 00:00:00. You can, however, enter a value in the field.Note: The value must represent the time zone of the Production Unit. | ||||||||
Updated By | Character | The user name of the Security User who last modified the Production Event. | This field is disabled. It is populated with a value only if you modify the record.
| ||||||||
Updated Date | Date | The date and time when the Production Event was last modified. |
This field is disabled. It is populated with a value only if you modify the record. | ||||||||
Work History | Character | A reference to the work that was performed as a result of the Production Event. | This field appears in the datasheet as the Work History Link box. You can enter or select a value in the field. |
Production Loss Records
This family is enabled for site filtering, which means that records in this family can be assigned to a specific site, and will then only be accessible to users who are assigned to the same site and have the appropriate license and family privileges. For more information, refer to the Site Filtering section of the documentation.
Field | Data Type | Description | Behavior and Usage |
---|---|---|---|
Comment | Character | Additional comments about the loss. | You can enter a value in this field. |
Equivalent Downtime Hours | Numeric | The amount of time that a Production Unit would need to operate at maximum sustained capacity to equal the loss. |
This field is disabled. If the Loss Amount field in the Production Loss and the Maximum Sustained Hourly Rate field in the related Production Profile contain values, this field is automatically populated using the following formula: Equivalent Downtime Hours = Loss Amount / Maximum Sustained Hourly Rate |
Impact Code | Character | The impact of the loss. |
This field contains a list of all Impact Codes that are returned by the ImpactCodeList query. Each item in the list appears in the following format: Code - Description where Code and Description are values in the Code and Description fields respectively in the Impact Code. When you select an item from the list, while the Code and Description are displayed in the datasheet, only the Code is stored in the field. |
Loss Amount | Numeric | The amount of production that was lost. |
When you create a Production Loss, this field is automatically populated with the value in the Unaccounted Loss field in the Production Loss. You can, however, enter a value in the field. If the Equivalent Downtime Hours field in the Production Loss and the Maximum Sustained Hourly Rate field in the related Production Profile contain values, this field will be automatically populated using the following formula: Loss Amount = Equivalent Downtime Hours x Maximum Sustained Hourly Rate If the Equivalent Downtime Hours field is blank, and if you enter a value in the Loss Amount field, the Equivalent Downtime Hours field will be automatically populated based on the formula. |
Margin ID | Character |
The margin defined for the related Production Profile. |
This field is used to calculate the cost of losses. It contains a list of all margins that are defined for the related Production Profile. It is automatically populated with the default margin of the Production Profile. |
OEE Code | Character |
A value that is used to categorize the loss based on the effectiveness of the production process. |
Selecting this field displays the Select OEE Code window, which contains a hierarchical tree of OEE Codes that are mapped to the selected Impact Code. These OEE Codes are returned by the GetOEECodeByImpactKey query. |
Production Event | Character | The event that caused the loss. |
This field contains a list of Event IDs of all Production Events that are returned by the EventList query. The field, however, stores the key of the Production Event. The Production Events are sorted chronologically in descending order based on Start Date. |
Production Plan Records
Production Plan records store information about the quantity of product that you plan to produce within a certain time period. This topic provides an alphabetical list and description of the fields that exist for the Production Plan family and appear on the Production Plan datasheet. The information in the table reflects the baseline state and behavior of these fields.
This family is enabled for site filtering, which means that records in this family can be assigned to a specific site, and will then only be accessible to users who are assigned to the same site and have the appropriate license and family privileges. For more information, refer to the Site Filtering section of the documentation.
Field | Data Type | Description | Behavior and Usage |
---|---|---|---|
Data Entry Frequency | Character | A value representing how often you plan to enter production data and losses. | This field contains the following values:
|
End Time | Date | The date and time on which the plan ends. |
For a Time-based plan, depending on the value you selected in the Template Frequency field, the end time is populated automatically. For a Quantity-based plan, the value is determined automatically based on the product quantity and start time that you specified. |
Plan Basis | Character |
The type of production plan. |
This field contains the following options:
|
Plan ID | Character | A value that identifies the production plan. | You can select the link for a plan ID to view its details. |
Plan Type | Character | A value indicating the type of plan. |
The value in this field will be AP (Actual Plan) if you have created a Production Plan: The value in this field will be PT (Plan Template) if you created a Plan Template. |
Production Model | Character |
The order in which the products will be produced. |
This field contains the following values:
|
Start Time | Date | The date and time on which the plan begins. | This field is populated automatically with the current date. |
Template Description | Character | A description of the production plan template. | You can enter a description for the Production Plan Template that you are creating or modifying. |
Template Frequency | Character | A value representing the end date of the production plan template. |
On the datasheet, this field appears as a list labeled Duration. You can select one of the following values:
|
Template Name | Character | The name of the production plan template. | You can enter a value in this field manually. |
Production Profile Records
Production Profile records store information about a product and its corresponding production unit. This topic provides an alphabetical list and description of the fields that exist for the Production Profile family and appear on the Production Profile datasheet. The information in the table reflects the baseline state and behavior of these fields.
This family is enabled for site filtering, which means that records in this family can be assigned to a specific site, and will then only be accessible to users who are assigned to the same site and have the appropriate license and family privileges. For more information, refer to the Site Filtering section of the documentation.
Field | Data Type | Description | Behavior and Usage | ||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Description | Text | A detailed description of the production profile. | You can enter a value manually. | ||||||||||||||
Max Demonstrated Rate | Numeric | The highest number of products the production unit produced, disregarding the impact it may have had on the assets involved in the process or the quality of the product. | After you navigate away from the Max Demonstrated Rate box, the value that you entered is appended with the value Product UOM / Production Rate UOM, where:
| ||||||||||||||
Max Sustained Capacity Rate | Numeric | The number of products that the production unit can produce consistently without having any adverse effects on the assets involved in the process or the quality of the product. | This field is disabled, and the value is populated by default based on the values in the following fields:
Standard Batch Size / Standard Batch Cycle Time The numeric value is then appended with the value Product UOM / Production Rate UOM, where:
| ||||||||||||||
Maximum Sustained Hourly Rate | Numeric | The rate associated with the hourly rate of Equivalent Downtime Hours. |
This field is automatically populated only if the MSHR Auto Calculate check box in the Settings window is selected. You can, however, enter a value manually. The following formula is used to populate this field: Standard Batch Size / Production Rate UOM (hours), where:
This field is used to calculate Equivalent Downtime Hours. This field is not required; however, if left blank, Equivalent Downtime Hours will not be used when reconciling losses. | ||||||||||||||
OPC Tag ID | Character | The tag whose readings you want to use to create Production Data records automatically. |
This field contains a button, which enables you to select the required OPC Tag. This field is required if you want to use the process historian to production data. | ||||||||||||||
Planning Rate | Numeric | The rate that is associated with the useful production time. | This field populates the Short Range Plan field based on the following calculation: Planning Rate × Useful Production Time. | ||||||||||||||
Product | Character | The product associated with the profile. | This field contains a list of all values in the Name field in all Products. When you save the Production Profile, it will be linked automatically to the selected Product. After the two records are linked, if you change the value in the Name field in the Product, the value in the Product field in the Production Profile will be updated automatically to reflect the change. | ||||||||||||||
Product Alias | Character | Name of the product associated with the profile. | This field is populated with text from the Product field and will populate the Product Name field that appears in Production Plans and Production Plan Templates. This field can be modified. | ||||||||||||||
Product UOM | Character | The unit that is associated with the product that is stored in the Product field. For example, if you are producing steel, the unit might be Tons. | This field contains a list, which displays the values that exist in the Product UOM field in all existing Production Profiles. You can select a value from the list or enter a new value. | ||||||||||||||
Production Rate UOM | Character | How often you measure production (e.g., Day). |
This field contains a list with the following values, which come from the System Code Table with the ID MI_PLA_RATE_UOM:
The default value is Day. This is a required field. | ||||||||||||||
Standard Batch Cycle Time | Character | The amount of time it takes you to produce one batch of the product that is stored in the Product field. |
The number that you enter is appended automatically with the value in the Production Rate UOM field. This is a required field. | ||||||||||||||
Standard Batch Size | Character | The amount of product that you can produce in one batch. | The number that you enter is appended automatically with the value in the Product UOM field. This is a required field. |
Production Unit Records
Production Unit records store basic information about a single production unit. This topic provides an alphabetical list and description of the fields that exist for the Production Unit family and appear on the Production Unit datasheet. The information in the table reflects the baseline state and behavior of these fields.
Field | Data Type | Description | Behavior and Usage |
---|---|---|---|
Associated Unit | Character | A reference to a separate that contains more information about the Production Unit. |
Using this field, you can associate production loss to the asset hierarchy and information about all the losses will available at the asset hierarchy level of the associated unit. This field contains the button, which you can use to select the Functional Location that contains more information about the production unit. When you save the Production Unit, it will be linked automatically to the selected Functional Location. |
Production Unit Description | Text | A description of the Production Unit. | You can define this field manually. |
Production Unit Name | Character | The name of the Production Unit. | This field is required. |
Timezone | Character | The time zone that is associated with the Production Unit. |
By default, this field is set to (UTC - 05:00) Eastern Time (US & Canada). Important: If you create a plan with one time zone and later modify the time zone, the dates are updated in the UI based on the new time zone when you view the Production Data. The Production Data, however, will be corrupted if you add new data, modify the existing data, or delete the existing data.
|
Profile Margin Records
Profile Margin records store information about the Margins in Production Profiles. This topic provides an alphabetical list and description of the fields that exist for the Profile Margin family and appear in the Margins subsection. The information in the table reflects the baseline state and behavior of these fields.
Field | Data Type | Description | Behavior and Usage |
---|---|---|---|
Default (Yes/No) | Numeric | The Production Profile default Margin. | You will select yes or no from a list to determine which Margin will be the default for the selected Production Profile. |
Margin ID | Character | The ID given to a Margin. | You will enter an ID for a Margin. |
Margin Value | Numeric | The value given to a Margin. | You will enter the value of a Margin. |