Family Field Descriptions
Data Entry Form Definition Records
Data Entry Form Definition records store information about fields that are defined for the Data Entry Form Definition family in the baseline GE Digital APM database. This topic provides an alphabetical list and description of fields that exist for the Data Entry Form Definition family and appear in the Data Entry Form Definition datasheet (that is, in the Form section of a data entry form), unless otherwise specified. The information in the table reflects the baseline state and behavior of these fields. The table is not comprehensive.
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 Sites section of the documentation.
| Field | Data Type | Description | Behavior and Usage |
|---|---|---|---|
| Description | Text | Identifies the description of the data entry form. | You can enter a value in this field. |
| Form ID | Character (127) | Identifies the ID of the data entry form. | This field is required. You can enter a value in the field. The value must be unique. |
Data Entry Form Field Records
Data Entry Form Field records store information about fields that are defined for the Data Entry Form Field family in the baseline GE Digital APM database. This topic provides an alphabetical list and description of fields that exist for the Data Entry Form Field family and appear in the Data Entry Form Field datasheet (that is, in the Form Designer section of a data entry form), unless otherwise specified. The information in the table reflects the baseline state and behavior of these fields. The table is not comprehensive.
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 Sites section of the documentation.
| Field | Data Type | Description | Behavior and Usage |
|---|---|---|---|
| Field Name | Character (255) | Identifies the field that you can choose to display in the data entry form for an assignment. | This field is required. You can enter a value in the field. Each value appears as a field in the data entry form for the assignment. |
| Is Active | Boolean | Indicates whether the value in the Field Name field appears in the data entry form for the assignment. | By default, this check box is selected, indicating that the value in the Field Name field appears in the data entry form for the assignment. Clear the check box if you do not want the value in the Field Name field to appear in the data entry form for the assignment. |
| Is Mandatory | Boolean | Indicates whether the value in the Field Name field is mandatory in the data entry form for the assignment. | By default, this check box is cleared, indicating that the value in the Field Name field is not mandatory in the data entry form for the assignment. Select the check box if you want the value in the Field Name field to be mandatory in the data entry form for the assignment. |
| Type | Character (50) | Identifies the data type of the value in the Field Name field (that is, Boolean, Character, or Numeric). | This field is required and populated by the MI_FF_TYPE System Code Table. You can select a value in the field. |
eLog Entry Comment Records
eLog Entry Comment records store information about fields that are defined for the eLog Entry Comment family in the baseline GE Digital APM database. This topic provides an alphabetical list and description of fields that exist for the eLog Entry Comment family and appear in the Comment window, unless otherwise specified. The information in the table reflects the baseline state and behavior of these fields. The table is not comprehensive.
This family inherits the site filtering setting of the eLog Entry family.
| Field | Data Type | Description | Behavior and Usage |
|---|---|---|---|
| Comment Text | Character | Identifies the comment. | You can enter a value in this field. |
eLog Entry Records
This topic provides an alphabetical list and description of fields that exist for the subfamilies of the eLog Entry family. When you attempt to create a log entry in the Shift Log workspace, each subfamily of the eLog Entry family appears as an option.
The eLog Entry family and its subfamilies inherit the site filtering setting of the Shift family. For more information, refer to the Site Filtering section of the documentation.
eLog General Entry Records
| Field | Data Type | Description | Behavior and Usage |
|---|---|---|---|
| Assign To | Character (50) | Identifies the assignee of the general log entry. | This field contains a list of all Team Members who are assigned to the Functional Location and the Shift to which you are signed in. You can select a value in the field. |
| Causing Asset | Numeric | Identifies the asset associated with the general log entry. | This field contains a list of Equipment records associated with the Functional Location to which you are signed in. You can select a value in the field. |
| Headline | Character (256) | Identifies the heading for the general log entry. | This field is required. You can enter a value in the field. |
| Log Entry Type | Character (150) | Identifies the type of the general log entry. |
This field is required. It contains values from the Log Entry Type field in the log entry type record for the eLog General Entry family. You can select a value in the field. |
| Log Text | Text | Identifies the description of the general log entry. | This field is required. You can enter a value in the field. |
| Priority | Character (50) | Identifies the priority of the general log entry. | This field is populated by the MI_ELOG_TEMPLATE_PRIORITY System Code Table. By default, the field is populated with the value Medium. You can, however, select a different value. |
| Session ID | Numeric | Identifies the session associated with the general log entry. | This field does not appear in the datasheet. |
| Shift ID | Numeric | Identifies the Shift associated with the general log entry. | This field is disabled. It contains the Functional Location and the Shift to which you are signed in. |
| Status | Character (50) | Identifies the status of the general log entry. | This field is populated by the MI_ELOG_ENTRY_STATUS System Code Table. By default, the field is populated with the value New. You can, however, select a different value. |
eLog Generation Event Records
| Field | Data Type | Description | Behavior and Usage |
|---|---|---|---|
| Assign To | Character (50) | Identifies the assignee of the generation event log entry. | This field does not appear in the datasheet. |
| Associated Event Id | Character (50) | Identifies the Event associated with the generation event log entry. |
This field is not inherited from the eLog Entry family. The field is always disabled. If the log entry is associated with an Event in the Generation Availability Analysis (GAA) module, by default, this field is populated with the ID of that Event; the ID appears as a link. |
| Causing Asset | Numeric | Identifies the asset associated with the generation event log entry. | This field contains a list of Equipment records associated with the Functional Location to which you are signed in. You can select a value in the field. |
| End Date | Date | Identifies the end date and time of the Event associated with the generation event log entry. |
This field is not inherited from the eLog Entry family. If the log entry is created in the eLog module, you can enter a value in this field. If the log entry is created from an Event in the GAA module, by default, this field is populated with the end date and time of the Event. You can, however, modify the value in the field. |
| Headline | Character (256) | Identifies the heading for the generation event log entry. |
This field is required. If the log entry is created in the eLog module, you can enter a value in this field. If the log entry is created from an Event in the GAA module, by default, this field is populated with the name of the Event. You can, however, modify the value in the field. |
| Log Entry Type | Character (150) | Identifies the type of the generation event log entry. |
This field is required. It contains values from the Log Entry Type field in the log entry type record for the eLog Generation Event family. If the log entry is created in the eLog module, you can select a value in this field. If the log entry is created from an Event in the GAA module, by default, this field is populated with the value Generation Event. You can, however, select a different value in the field. |
| Log Text | Text | Identifies the description of the generation event log entry. | This field is required. You can enter a value in the field. |
| Priority | Character (50) | Identifies the priority of the generation event log entry. | This field is populated by the MI_ELOG_TEMPLATE_PRIORITY System Code Table. By default, the field is populated with the value Medium. You can, however, select a different value. |
| Session ID | Numeric | Identifies the session associated with the generation event log entry. | This field does not appear in the datasheet. |
| Shift ID | Numeric | Identifies the Shift associated with the generation event log entry. | This field is disabled. It contains the Functional Location and the Shift to which you are signed in. |
| Start Date | Date | Identifies the start date and time of the Event associated with the generation event log entry. |
This field is not inherited from the eLog Entry family. If the log entry is created in the eLog module, you can enter a value in this field. If the log entry is created from an Event in the GAA module, by default, this field is populated with the start date and time of the Event. You can, however, modify the value in the field. |
| Status | Character (50) | Identifies the status of the generation event log entry. | This field is populated by the MI_ELOG_ENTRY_STATUS System Code Table. By default, the field is populated with the value New. You can, however, select a different value. |
eLog Entry Type Color Records
eLog Entry Type Color records store information about fields that are defined for the eLog Entry Type Color family in the baseline GE Digital APM database. This topic provides an alphabetical list and description of fields that exist for the eLog Entry Type Color family and appear in the eLog Entry Type Color datasheet (that is, the log entry type record in the Log Entry Type workspace), unless otherwise specified. The information in the table reflects the baseline state and behavior of these fields. The table is not comprehensive.
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 Sites section of the documentation.
| Field | Data Type | Description | Behavior and Usage |
|---|---|---|---|
| Family Name | Character (50) | Identifies the family to which the log entry type belongs. | This field is required. It contains a list of sub families of the eLog Entry family. You can select a value in the field. |
| Log Entry Type | Character (150) | Identifies the log entry type for the sub family of the eLog Entry family. |
This field is required. You can enter a value in the field. When you modify or create a log entry, the value that you enter in this field appears as an option in the Log Entry Type field. |
| Log Entry Type Color | Character (50) | Identifies the color for the log entry type. |
This field is populated by the MI_ELOGTYPE_COLOR System Code Table. It contains a list of colors that you can assign to the log entry type. You can select a value in the field. In the Shift Summary page, in the Shift Log workspace, the log entry created for the log entry type that you enter in the Log Entry Type field appears in the color that you have selected in this field. If you have not selected a value in this field, the log entry appears in the black color. |
eLog Login Records
eLog Login records store information about fields that are defined for the eLog Login family in the baseline GE Digital APM database. This topic provides an alphabetical list and description of fields that exist for the eLog Login family and appear in the Sign In window when you sign in to a Shift, unless otherwise specified. The information in the table reflects the baseline state and behavior of these fields. The table is not comprehensive.
This family inherits the site filtering setting of the Shift family. For more information, refer to the Site Filtering section of the documentation.
| Field | Data Type | Description | Behavior and Usage |
|---|---|---|---|
| Emergency Sign Out performed by | Numeric | Identifies the Team Member who can end the session of another Team Member. |
This field does not appear in the window. You can end the session of another Team Member depending on the value in the Perform Emergency Sign Off? field of the associated Role Configuration record (that is, the Role Configuration record for your role). |
| Role | Character (50) | Identifies the Role of the Team Member who is signing in to the Shift. |
This field is required. It contains values from the Can Sign In As field of the associated Role Configuration record. You can select a value in the field. |
| Shift | Numeric | Identifies the Shift. |
This field is required. It appears in the window as the Shifts box and contains a list of all Shifts that are assigned to you. These Shifts appear in the box along with their Functional Locations. You can select one or more Shifts in the field depending on the value in the Login In Multiple Shifts? field in the associated Role Configuration record. |
| Sign In Time | Date | Identifies the time when the Team Member signs in to the Shift. | This field does not appear in the window. |
| Sign Out Time | Date | Identifies the time when the Team Member signs out of the Shift. | This field does not appear in the window. |
| Taking over from | Numeric | Identifies the Team Member from whom you want to take over the Shift. |
This field contains a list of all Team Members who are assigned to the Shifts selected in the Shift field. You can select one or more values depending on the value in the Login In Multiple Shifts? field in the associated Role Configuration record. |
eLog Role Configuration Records
eLog Role Configuration records store information about fields that are defined for the eLog Role Configuration family in the baseline GE Digital APM database. This topic provides an alphabetical list and description of fields that exist for the eLog Role Configuration family and appear in the eLog Role Configuration datasheet, unless otherwise specified. The information in the table reflects the baseline state and behavior of these fields. The table is not comprehensive.
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 Sites section of the documentation.
| Field | Data Type | Description | Behavior and Usage |
|---|---|---|---|
| Can Sign In As | Character (50) | Identifies the role that the Team Member can use to sign in to a Shift. | This field contains values from the Team Member Role field of the Role Configuration records. You can select one or more values in the field. |
| Perform Emergency Sign Out? | Boolean | Determines whether the Team Member can end the session of another Team Member. |
By default, this check box is cleared, indicating that the Team Member cannot end the session of another Team Member. Select the check box if you want the Team Member to be able to end the session of a different Team Member. |
| Sign in to Multiple Shifts? | Boolean | Determines whether the Team Member can sign in to multiple Shifts and take over the Shift from multiple Team Members. |
By default, this check box is cleared, indicating that the Team Member cannot sign in to multiple Shifts and can take over the Shift from only one Team Member. Select the check box if you want the Team Member to be able to sign in to multiple Shifts and take over the Shift from any one Team Member per Shift. |
| Team Member Role | Character (50) | Identifies the role of the Team Member. |
This field is required and populated by the TEAM_MEMBER_ROLES System Code Table. You can select a value in the field; however, after the record is saved, the field is disabled.
Note: For a given role, if a Role Configuration record already exists, the role does not appear in the field. |
eLog Template Records
eLog Template records store information about fields that are defined for the eLog Template family in the baseline GE Digital APM database. This topic provides an alphabetical list and description of fields that exist for the eLog Template family and appear in the eLog Template datasheet, unless otherwise specified. The information in the table reflects the baseline state and behavior of these fields. The table is not comprehensive.
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 Sites section of the documentation.
| Field | Data Type | Description | Behavior and Usage |
|---|---|---|---|
| Assignee(s) | Character (50) | Identifies the Roles of the assignees for an assignment. |
This field contains values from the Team Member Role field of the Role Configuration records. You can select multiple values in the field. You are considered to be the assignee of the Template if the value in this field corresponds to your role. If you are the assignee of the Template that is applied to a Shift, when you access the My Assignments workspace for the Shift, the Template appears as an assignment in the Incomplete Assignments section. An assignee of the Template cannot access the associated assignment if it has been submitted for review; only a reviewer can access it. |
| Data Entry Form | Numeric | Identifies the data entry form for the assignment. | This field is enabled only if the value in the Type field is Assignment. It contains values from the Form ID field of all the data entry forms. You can select a value in the field. |
| Description | Text | Identifies the description of the Template. | You can enter a value in this field. |
| Generated On | Character (50) | Indicates whether the assignment should be created when you sign in to a Shift. |
This field is required and populated by the MI_ELOG_TEMPLATE_GEN_ON System Code Table. You can select a value in the field. If the value in the field is Sign In, the assignment will be created when you sign in to the Shift. If the value in the field is Sign Out, the assignment will be created when you sign out of the Shift. |
| Priority | Character (50) | Identifies the priority of the assignment. | This field is enabled only if the value in the Type field is Assignment. It is populated by the MI_ELOG_TEMPLATE_PRIORITY System Code Table. You can select a value in the field. |
| Reviewer(s) | Character (50) | Identifies the Roles of the reviewers of an assignment. |
This field is enabled only if the value in the Type field is Assignment. It contains values from the Team Member Role field of the Role Configuration record. You can select multiple values in the field. You are considered to be the reviewer of the Template if the value in this field corresponds to your role. A reviewer of the Template can access the associated assignment if it has been submitted for your review. |
| Shift(s) | Text | Identifies the Shift to which the Template will be applied. | This field does not appear in the datasheet. It is required only when you apply the Template to Shifts (that is, in the Apply Template to Shifts window). |
| Template ID | Character (255) | Identifies the ID of the Template. | This field is required. You can enter a value in the field. The value must be unique. |
| Type | Character (50) | Identifies the type (that is, assignment) of the Template. |
This field is required and populated by the MI_ELOG_TYPE System Code Table. You can select a value in the field. If the value in the field is Assignment, an assignment will be created for the Shift that has the same value in the Functional Location field as that in the Functional Location(s) field of the Template. This assignment is created for users who are assigned to the Roles selected in the Role(s) field. |
Shift Records
Shift records store information about fields that are defined for the Shift family in the baseline GE Digital APM database. This topic provides an alphabetical list and description of fields that exist for the Shift family and appear in the Shift datasheet, unless otherwise specified. The information in the table reflects the baseline state and behavior of these fields. The table is not comprehensive.
This family inherits the site filtering setting of the Functional Location family. For more information, refer to the Site Filtering section of the documentation.
| Field | Data Type | Description | Behavior and Usage |
|---|---|---|---|
| Description | Text | Identifies the description of the Shift. | You can enter a value in this field. |
| End Date | Date | Identifies the end date of the Shift. | You can enter a value in this field. |
| End Time | Date | Identifies the end time of the Shift for a given day. | This field is required. You can enter a value in the field. |
| Functional Location | Numeric | Identifies the functional location of the Shift. | This field is disabled and populated by default. |
| Shift Name | Character (255) | Identifies the name of the Shift. | This field is required. It appears in the datasheet as Shift ID. You can enter a value in the field. The value must be unique for a given Functional Location. |
| Start Date | Date | Identifies the start date of the Shift. | This field is required. It appears in the datasheet as Effective Date. You can enter a value in the field. |
| Start Time | Date | Identifies the start time of the Shift for a given day. | This field is required. You can enter a value in the field. Note: To account for the buffer time of two hours for signing in to a Shift or signing out of a Shift, the difference between the end date and time of a Shift and the start date and time of the previous occurrence of the same Shift must be more than four hours. |
| Teams | Character (512) | Identifies the Teams assigned to the Shift. | When you select this field, the Add Teams to Shift window appears, displaying a list of Teams that you can assign to your Shift. Note: Only the Teams that are assigned to the Site to which the Functional Location (that is, the value in the Functional Location field) belongs appear in the window. |