Family Field Descriptions
Family Field Descriptions
This topic provides a listing of all the families in the Rounds Designer module, with links to the family fields information.
Checkpoint Condition Records
Checkpoint Condition records store details about the conditions of Checkpoints on a Route. This topic provides an alphabetical list and description of the fields that exist for the Checkpoint Condition family. The information in the table reflects the baseline state and behavior of these fields. This list is not comprehensive.
This family is enabled for site filtering, which means that records in this family can be assigned to a specific site and will 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 Sites section of the documentation.
Field |
Data Type |
Description |
Behavior and Usage |
---|---|---|---|
Condition ID | Character | A unique value that identifies the condition of the Checkpoint | This field is populated automatically by the Rounds module. Alternatively, you can enter a value in this field, but the value must be unique. |
Field Name | Character | The name of the Checkpoint condition | This field is populated automatically by the template or by the data loader used to create the condition, or by the Rounds Designer module. |
Field Value for Character Type | Character | The field that stores the value of the Checkpoint condition if the value is a character value | The use of this field as opposed to the Field Value for Numeric Type field is determined by the predecessor Checkpoint record of the Condition record. You can enter the value of this field in the Select Value box when adding a condition to a Checkpoint. |
Field Value for Numeric Type | Numeric | The field that stores the value of the Checkpoint condition if the value is a numeric value | The use of this field as opposed to the Field Value for Character Type field is determined by the predecessor Checkpoint record of the Condition record. You can enter the value of this field in the Select Value box when adding a condition to a Checkpoint. |
Possible Condition | Character | The relational value of a Checkpoint | You can select the value of this field in the Select Relation box when adding a condition to a Checkpoint. |
Predecessor Key | Numeric | The entity key of a predecessor Checkpoint | This field is populated automatically by the predecessor Checkpoint. |
Related Template Group Key | Numeric | The entity key of the Template Group applied to the Route containing the Checkpoint condition | This field is populated automatically by the Template Group key that generated the condition. |
Route Key | Numeric | The entity key of the Route containing the Checkpoint condition | This field is populated automatically by the Route of which the condition is a part. |
Type | Character | The type of Checkpoint condition | This field is populated by the predecessor Checkpoint record of the Condition record. |
Checkpoint Task Records
Checkpoint Task records store details on the schedule on which a Checkpoint should be executed. This topic provides an alphabetical list and description of the fields that exist for the Checkpoint Task family. The information in the table reflects the baseline state and behavior of these fields. This list is not comprehensive.
This family is enabled for site filtering, which means that records in this family can be assigned to a specific site and will 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 Sites section of the documentation.
Field | Data Type | Description | Behavior and Usage |
---|---|---|---|
Last Date | Date | The date on and time at which the last reading was recorded for this Checkpoint | This field is populated automatically after a Reading is created and linked to the Measurement Location to which the Checkpoint Task is linked, with the value in the Reading Taken Date field of the Reading. |
Next Date | Date | The date on and time at which the next reading for this Checkpoint becomes due | This field is populated automatically based on the values in the Schedule field and the Last Date field. If the Last Date field is empty, the value in the Next Date field is calculated as the next date and time that meets the defined schedule after the current date and time. |
Non-compliance Date | Date | The date and time after which the reading will be considered non-compliant |
This field is populated automatically based on the values in the Schedule and the Next Date fields. By Default, Non-Compliance Date value is populated as: Next Date Value + Non Compliance Date Interval (in days). If Non Compliance Date Interval is absent, then Next Compliance Date value is populated as: Next Date + Schedule Interval. |
Non-Complinace Date Interval | Numeric | The Non Compliance Date Interval (in days) added to Next Date to get the Non-Compliance Date |
This field is not populated automatically. If Non Compliance Date Interval is absent, then Next Compliance Date value is populated as: Next Date + Schedule Interval. |
Non-Compliance Next Check Date | Date | The date after which the Checkpoint is checked again for Compliance |
By Default, Non-Compliance Next Check Date value is = Non-Compliance Date |
Schedule | Character | The schedule by which you want to take readings for this Checkpoint. | This field contains an ellipsis button that you can select to access the Edit Schedule window, where you can define the schedule for the associated Checkpoint. |
Task ID | Character | The ID of the Checkpoint Task | This field is populated automatically with a value in the format CP-<n>, where <n> is a number representing the number of Checkpoint Tasks that have been initiated (even if they were not actually saved). You can change the value, if needed. |
Checkpoint Template Records
Checkpoint Template records store details about Checkpoint templates that can be used to create Checkpoints on a Route. This topic provides an alphabetical list and description of the fields that exist for the Checkpoint Template family. The information in the table reflects the baseline state and behavior of these fields. This list is not comprehensive.
This family is enabled for site filtering, which means that records in this family can be assigned to a specific site and will 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 Sites section of the documentation.
Field | Data Type | Description | Behavior and Usage |
---|---|---|---|
Automatically create health indicator | Boolean | Indicates whether a health indicator will be created automatically | In the datasheet, this field appears as a check box labeled Automatically create health indicator. When selected, a health indicator will be created automatically when the Checkpoint is created. |
Checkpoint Locked | Boolean | Indicates whether or not a Checkpoint will be locked until the device user scans the associated barcode | In the datasheet, this field appears as the Scan to Unlock? check box. When this field is set to:
Note:
|
Content GUID Char | Character | Character value of system field Content GUID | You can use this field to create a query that links a Checkpoint to its related Checkpoint template. |
Description | Character | A description of the template | In this box, you can enter a description of the action users will be completing when they enter readings for this Checkpoint. |
Include as Health Indicator Source | Boolean | Indicates whether a potential health indicator source is used to create health indicators. | In the datasheet, this field appears as a check box labeled Include as Health Indicator Source. When this check box is selected, health indicators are created for the selected source. When the check box is cleared, health indicators are not created for the selected source. |
Non Compliance Date Interval | Numeric | The number of days without a reading before the Checkpoint is considered non-compliant | You can enter a positive integer in this field. If the Non Compliance Date Interval field is blank, the Next Compliance Date value is populated with the combined values of the Next Date field in the Checkpoint Task family and the Schedule Interval, which is part of the Schedule field in the Checkpoint Task family. |
Requires Equipment Shutdown | Boolean | Indicates whether or not the equipment requires shutdown | In the datasheet, this field appears as a check box, which is cleared by default. |
Schedule | Character | The schedule by which you want to take readings for the Checkpoint template | You can select to view the Schedule window, where you can define the schedule for the Checkpoint template. |
Status | Character | The status of the Checkpoint | In the datasheet, this field appears as a list that is populated by the MI_FDC_STATUS_TYPE System Code Table. It is labeled Status and contains the following values:
The value in this field is set to Active by default. Inactive Checkpoints will not appear in the Data Collection page. |
Template ID | Character | The ID for the template | A value is required and must be unique. If you enter a value that is not unique to the Checkpoint template, a message appears indicating that the ID already exists. |
Unit of Measure | Character | The unit of measure that users can specify when entering a numeric reading value for the Checkpoint | This field appears as a list that is populated by the UOME System Code Table. This field is disabled if the value in the ML Type field in the Measurement Location family is set to Character, or if the value in the LR Type field in the Lubrication Requirement family is set to Check Off. Note:
Rounds does not use the Units of Measure Conversions feature. The system code table UOME is the only source for populating drop-down list values within UOM fields. The UOM field for a Measurement Location contains all the values from the UOME system code table, sorted by their descriptions. The UOM field for a Lubrication Requirement contains a subset of values from the UOME system code table based on specific reference values from the MI_LM_REFERENCES system code table. |
Lubricant Records
This topic provides an alphabetical list and description of the fields that exist for the Lubricant family. The information in the table reflects the baseline state and behavior of these fields. This list is not comprehensive.
Lubricant records serve as a means for organizing all the lubricants that are used by your company. When you create a Lubricant record, the values that you enter in these fields will be used to populate the corresponding lists on the Lubrication Requirement datasheet, where you can select the necessary values from a list.
This family is enabled for site filtering, which means that records in this family can be assigned to a specific site and will 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 Sites section of the documentation.
Field | Data Type | Description | Behavior and Usage |
---|---|---|---|
Description | Character | Description of the lubricant | You can enter a value in this field. |
Flash Point | Numeric | Flash point of the lubricant | You can enter a value in this field. |
Flash Point UOM | Character | The unit of measurement of the Flash point of the lubricant | On the datasheet, this field appears as a list that is populated by the MI_LUBRICANT_REFERENCES system code table. Note:
Rounds does not use the Units of Measure Conversions feature. The system code table UOME is the only source for populating drop-down list values within UOM fields. The UOM field for a Lubrication Requirement contains a subset of values from the UOME system code table based on specific reference values from the MI_LM_REFERENCES system code table. |
ISO Grade | Character | Viscosity grading of the lubricant | You can enter a value in this field. |
Lubricant | Character | The name of the lubricant | You can enter a value in this field. |
Lubricant Type | Character | The type of lubricant | On the datasheet, this field appears as a list that is populated by the MI_LUBR_TYPE system code table. |
Manufacturer | Numeric | The manufacturer of the lubricant |
On the datasheet, this field appears as a list that is populated with the values stored in the Manufacturer Name field in existing Lubricant Manufacturer records. This field displays the Manufacturer Name, but stores the Entity Key of the corresponding Lubricant Manufacturer record. If you are creating multiple Lubricant records, you may select the same or different manufacturers for each. |
Manufacturer's Part Number | Character | Manufacturer part number of the lubricant | You can enter a value in this field. |
Material Number | Character | Material number of the Lubricant (for example, the material number used in your EAM system) | You can enter a value in this field. |
Notes | Character | Any notes necessary for the lubricant | You can enter a value in this field. |
Storage Location | Character | Location where the lubricant is stored | You can enter a value in this field. |
Trade Name | Character | Brand name of the lubricant | You can enter a value in this field. |
Viscosity Rating | Character | Viscosity index of the lubricant | You can enter a value in this field. |
Lubricant Manufacturer Records
Lubricant Manufacturer records store details about the manufacturer of a lubricant. This topic provides an alphabetical list and description of the fields that exist for the Lubricant Manufacturer family. 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 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 Sites section of the documentation.
Field | Data Type | Description | Behavior and Usage |
---|---|---|---|
Manufacturer ID | Character | The ID that you want to use to identify a lubricant manufacturer | This field is required and must be unique. |
Manufacturer Name | Character | The name of a lubricant manufacturer |
This field is required and must be unique. This field is used to populate the list in the Manufacturer field of Lubricant records. |
Manufacturer Description | Character | A description of the lubricant manufacturer | This field is optional. |
Lubrication Component Records
Lubrication Component records store information about lubrication components and provide values for drop-down lists used in the Lubrication Requirement and Lubrication Requirement Template families. This topic provides an alphabetical list and description of the fields that exist for the Lubrication Component family and appear on the Lubrication Component 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 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 Sites section of the documentation.
Field | Data Type | Description | Behavior and Usage |
---|---|---|---|
Component Sub Type | Character | The sub type of a lubrication component type | The values in this field populate the Component Sub-Type lists on Lubrication Requirement and Lubrication Requirement Template datasheets. |
Component Type | Character | The type of lubrication component |
Organizes records in the Lubrication Component family into distinct groups. The values in this field populate the Component lists on Lubrication Requirement and Lubrication Requirement Template datasheets. |
Description | Character | The description of the lubrication component type or sub type | If there is a value in the corresponding Component Sub Type field, then the value in this field is a description of the Component Sub Type. However, if the corresponding Component Sub Type field is empty, then the value in this field is a description of the Component Type. |
ID | Character | A unique value that identifies the lubrication component | This field is required and must be unique. |
Lubrication Management Recommendation Record
This topic provides an alphabetical list and description of the fields that exist for the Lubrication Management Recommendations. The information in the table reflects the baseline state and behavior of these fields. This list is not comprehensive.
This family is enabled for site filtering, which means that records in this family can be assigned to a specific site and will 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 Sites section of the documentation.
Field | Data Type | Description | Behavior and Usage |
---|---|---|---|
Asset ID | Numeric | The ID of the Asset for which the recommendation is being made | This is Unique for a particular equipment. |
Assigned To Name | Text | Name of the person responsible for ensuring the recommendation is implemented | Enter the name of the person to whom would be responsible for ensuring the recommendation is implemented. |
Author Name | Text | Name of the person proposing the recommendation | You can enter the name of the user to which the recommendation is associated. |
Create Work Request? | Check box | Enables a work request | All the other Work request details are enabled after the check box is selected. |
Final Approver Name | Text | Name of the individual ultimately responsible for approving the recommendation and the associated expenditure | You can pick a user from the list as an approver. |
Recommendation Basis | Text | The background as to why the recommendation is being made | You can type in the description in the text box. |
Recommendation Description | Text | Details of the recommendation | You can type in the description in the text box. |
Recommendation Headline | Text | A brief summary of the recommendation subject | Disabled after the author has set the author lock. |
Recommendation ID | Text | The unique ID for the Recommendation | This is unique. |
Recommendation Priority | Picklist | The priority of recommendation for implementation | Enter the value from the list that best represents the priority of recommendation for implementation.
|
Required Equipment Status | Character | The operating state the Equipment or Functional Location needs to be in, in order to implement the recommendation | None |
Reviewer Name | Text | Name of the individual responsible for reviewing and endorsing the recommendation | You can pick a user as a reviewer from the list. |
Target Completion Date | Date | Date by which the recommendation is intended to be implemented | User to select a date from the calendar. |
Technical Number | Numeric | Number associated with the equipment and recommendation request | This number is unique. |
Work Request Equipment | Character | The work request associated with Equipment | This is populated automatically. |
Work Request Functional Location | Character | The work request associated with the Functional Location record | This is populated automatically. |
Work Request Reference | Numeric | The ID of the work request that may be associated with the recommendation | This is populated automatically. |
Lubrication Requirement Records
Lubrication Requirement records store details about Checkpoints on a Route. This topic provides an alphabetical list and description of the fields that exist for the Lubrication Requirements family. The information in the table reflects the baseline state and behavior of these fields. This list is not comprehensive.
This family is enabled for site filtering, which means that records in this family can be assigned to a specific site and will 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 Sites section of the documentation.
Field | Data Type | Description | Behavior and Usage |
---|---|---|---|
Asset Description | Character | A description of the equipment or location represented by the Equipment or Functional Location to which you want to link the Lubrication Requirement |
On the datasheet, this field appears as a text box labeled Asset Description. When the Lubrication Requirement is linked to:
If you do not want APM to populate the field automatically, you can enter a description for the equipment or location directly into the Asset Description cell. |
Asset ID | Character | The ID of the Equipment or Functional Location to which you want to link the Lubrication Requirement |
On the datasheet, this field appears as a text box labeled Asset ID. When the Lubrication Requirement is linked to:
|
Capacity | Number | A number representing the amount of lubricant that the component will hold | You can enter a value in this field. |
Capacity Unit of Measure | Character | A value representing the UOM associated with the value in the Capacity field | On the datasheet, this field appears as list that is populated by the MI_LM_REFERENCES system code table. |
Checkpoint ID | Character | The ID of the Checkpoint for the Lubrication Requirement | You can enter a value in this field. |
Component Sub Type | Character | The subtype of a lubrication component type |
On the datasheet, this field appears as a list labeled Component Subtype and is populated with the values stored in the Component Sub Type field in the existing Lubrication Component records. This list is filtered by the value that you select in the Component list. |
Component Type | Character | The type of lubrication component | On the datasheet, this field appears as a list labeled Component and is populated with the values stored in the Component Type field in the existing Lubrication Component records. |
Description | Character | A description of the Checkpoint |
On the datasheet, this field appears as a text box labeled LR Description. In this box, you can enter a description of the action users will be completing when they enter readings for this Checkpoint. This is a required field. |
LR Type | Character | The type of data that users can enter when creating a Reading linked to the Lubrication Requirement | On the datasheet, this field appears as a list that is populated by the MI_LM_LUBR_REQ_TYPE system code table. |
Lubricant | Character | The lubricant that is required for this Checkpoint |
On the datasheet, this field appears as a list labeled Lubricant and is populated with the values stored in the Lubricant field in the existing Lubricant records. This list is filtered by the values that you select in the Lubricant Manufacturer and Lubricant Type lists. |
Lubricant Manufacturer | Character | The company that manufactures the lubricant that users should use when completing this Checkpoint |
On the datasheet, this field appears as a list labeled Lubricant Manufacturer and is populated with the values stored in the Lubricant Manufacturer field in the existing Lubricant records. This list is filtered by the values that you select in the Lubricant list. If you have not yet selected a lubricant, the list is filtered based on the possible lubricants that you could select. |
Lubricant Type | Character | The type of Lubricant | On the datasheet, this field appears as a list that is populated by the MI_LUBR_TYPE system code table. |
Method Sub Type | Character | The subtype of a lubrication method type |
On the datasheet, this field appears as a list labeled Method Sub Type and is populated with the values stored in the Sub Type field in the existing Lubrication Method records. This list is filtered by the values that you select in the Lubricant and Method Type lists. |
Method Type | Character | The method by which the lubricant must be applied |
On the datasheet, this field appears as a list labeled Method Type and is populated with the values stored in the Type field in the existing Lubrication Method records. This list is filtered by the value that you select in the Lubricant list. |
Number of Points | Character | The number of points on the component that requires lubrication | You can enter the number of points that require lubrication. For example, if the component is an axle, you might enter 2 in this field. |
Priority | Character | A value representing the priority associated with the lubrication requirement | On the datasheet, this field appears as a list that is populated by the MI_LUBR_PRIORITY system code table. |
Related Ref Doc Image Key | Numeric | The entity key of a reference document | On the datasheet, this field appears as a text box labeled Checkpoint Image in which you can enter or select a reference document image that will be downloaded to a device and displayed when you access a checkpoint in Rounds Data Collection. |
Requires Equipment Shutdown | Boolean | Indicates whether the equipment requires shutdown | On the datasheet, this field appears as a check box, which is cleared by default. |
Status | Character | The status of the Lubrication Requirement |
On the datasheet, this field appears as a list labeled Status and contains the following values:
This field contains the value Active by default. Inactive Lubrication Requirement records will not appear in Data Collection pages. |
Template | Character | The Lubrication Requirement Template that you want to use to populate fields in the Lubrication Requirement |
On the datasheet, this field appears as a list displaying the Template IDs of the Lubrication Requirement Template records in your database. When you select a value, other fields in the record will be populated automatically based on the values in that template. After you save a Lubrication Requirement, the Content GUID of the selected Lubrication Requirement Template record is stored in the Template field, and the field is disabled. |
Unit of Measure | Character | The unit of measure that you can specify when entering a numeric reading value for a Checkpoint | On the datasheet, this field appears as a list that is populated by the MI_LM_REFERENCES system code table. This field is disabled if the value in the LR Type field is Check Off. Note:
Rounds does not use the Units of Measure Conversions feature. The system code table UOME is the only source for populating drop-down list values within UOM fields. The UOM field for a Lubrication Requirement contains a subset of values from the UOME system code table based on specific reference values from the MI_LM_REFERENCES system code table. |
Lubrication Requirement Template Records
Lubrication Requirement Template records can be used to create Lubrication Requirement records and contain all the fields included in Lubrication Requirement records, with the exception of the Template field in the Lubrication Requirement record. In addition, Lubrication Requirement Template records include the additional field Template ID, which stores the ID for the template. This value appears in the Template field in the Lubrication Requirement record.
This family is enabled for site filtering, which means that records in this family can be assigned to a specific site and will 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 Sites section of the documentation.
Measurement Location Records
Measurement Location records store details about Checkpoints on a Route. This topic provides an alphabetical list and description of the fields that exist for the Measurement Location family. The information in the table reflects the baseline state and behavior of these fields. This list is not comprehensive.
This family is enabled for site filtering, which means that records in this family can be assigned to a specific site and will 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 Sites section of the documentation.
Field | Data Type | Description | Behavior and Usage |
---|---|---|---|
Allowable Values | Character | The values the user can select when entering a reading for this Checkpoint | On the datasheet, this field appears as a list labeled Allowable Values and contains all the values in the Value field in the Operator Rounds Allowable Values family whose type values match the value stored in the ML Type and Category lists in the Measurement Location. To select or clear the field, select the value in the list. The indication that a value is selected is the vertical blue line to the left of the value. For example, suppose you select Character in the ML Type list and Pump Check in the Category list in a Measurement Location. If four allowable values contain the value Character in their Type field and Pump Check in their Category field, the Allowable Values list on the Measurement Location datasheet will contain the values in the Value field of those four allowable values. The values in this list are also used to populate the Numeric and Character lists on the Limit Values section of the ML Task View datasheet. These values are used to set up alerts that will be displayed to device users if they enter a certain reading value. In the Action section of the ML datasheet, the user can add Action Taken values to a list for any Measurement Location separately for the Limit Values. If you clear a check box from the Allowable Values list and the corresponding allowable value is used in the Limit Values section, that allowable value will automatically be removed from the Limit Values section. |
Allowable Values Temp | Character | Temporary field used by family policies to store values as they are being updated | By default, this field does not appear on the datasheet, and users cannot enter values into this field. The field is latent unless the Before Update and After Update Family Policies in the Operator Rounds Allowable Values family are activated. If these family policies are activated, this field temporarily stores Allowable Value changes during an update. |
Asset | Character | The Equipment or Functional Location which the user can add for the ML | On the datasheet, you can link an Equipment or a Functional Location to the Measurement Location. Depending on the selection, the Asset field is populated automatically. Also, the Asset Description, Asset ID fields are also populated. |
Asset Description | Character | A description of the equipment or location represented by the Equipment or Functional Location to which you want to link the Measurement Location | When the Measurement Location is linked to:
If you do not want APM to populate the field automatically, you can enter a description for the equipment or location directly into the Asset Description cell. |
Asset ID | Character | An ID of the equipment or location represented by the Equipment or Functional Location to which you want to link the Measurement Location | This field is populated automatically. |
Automatically create health indicator | Boolean | Indicates whether a health indicator will be created automatically | In the datasheet, this field appears as a check box labeled Automatically create health indicator. When selected, a health indicator will be created automatically when the Checkpoint is created. |
Category | Character | The category to which the Checkpoint belongs | On the datasheet, this field appears as a list labeled Category and contains the values that are defined in the Category field in the Operator Rounds Allowable Values family whose type matches the value that is stored in the ML Type field in the Measurement Location. You can select a value from the list. For example, if you select Character in the ML Type list in a Measurement Location and four allowable values contain the value Character in their Type fields, the Category list on the Measurement Location datasheet will contain the values in the Category field of those four allowable values. |
Category Temp | Character | Temporary field used by family policies to store values as they are being updated | By default, this field does not appear on the datasheet, and users cannot enter values into this field. The field is latent unless the Before Update and After Update Family Policies in the Operator Rounds Allowable Values family are activated. If these family policies are activated, this field temporarily stores Category changes during an update. |
Checkpoint ID | Character | The ID of the Checkpoint for the Measurement Location | You can enter a value in this field. |
Checkpoint Locked | Boolean | Indicates whether a Checkpoint should be locked on the Windows Mobile Device until the device user scans the associated barcode | On the datasheet, this field appears as a check box labeled Scan to Unlock?. When this field is set to:
This field is disabled when the Scan ID field is disabled. Note: This feature is not supported on tablet devices. |
Description | Character | A description of the Checkpoint | On the datasheet, this field appears as a text box labeled ML Description. In this box, you can enter a description of the action users will be completing when they enter readings for this Checkpoint (e.g., Pump Check, Vibration Check, or Temperature Check). This is a required field. |
Download Stored Document | Boolean | Indicates whether the Reference Documents associated with a route will be downloaded to a Windows CE mobile device | On the datasheet, this field appears as a check box. By default, this field is set to:
Note: Document download is not supported on tablet devices. However, tablet devices can open document types, regardless of file size, when connected to the APM Server. |
Equipment Technical Number | Character | The Equipment Technical Number of the Equipment | On the datasheet, this field appears as a text box labeled Equipment Technical Number. If the Measurement Location is linked to an Equipment, this field is populated automatically with the value stored in the Equipment Technical Number field in the Equipment. |
Include as Health Indicator Source | Boolean | Indicates whether a potential health indicator source is used to create health indicators. | In the datasheet, this field appears as a check box labeled Include as Health Indicator Source. When this check box is selected, health indicators are created for the selected source. When the check box is cleared, health indicators are not created for the selected source. |
Maximum Target Value | Numeric | A number representing the highest target reading value that is acceptable for the Checkpoint | On the datasheet, this field appears as a text box labeled Maximum Target Value, in which you can enter a number. Together, the value stored in this field and the value stored in the Minimum Target Value field define a target range that appear son the More Information screen on a Windows Mobile device. Note: This feature is not supported on tablet devices. This field is disabled when the value in the ML Type field contains Character. A rule exists on this field that will compare the value you enter in the Maximum Target Value field with the value you enter in the Minimum Target Value field. If you enter a value in the Maximum Target Value field that is less than the value in the Minimum Target Value field, a message will appear, indicating that the value must be greater than the value in the Minimum Target Value. |
Maximum Valid Value | Numeric | A number representing the highest reading value that is acceptable for the Checkpoint | On the datasheet, this field appears as a text box labeled Maximum Valid Value, in which you can enter a number. This value is used by the mobile device to check the reading value that is entered by the device user and display a message if the value they enter is higher than this value. Together, this value and the value in the Minimum Valid Value field define the valid value parameters for a reading. Note: This feature is not supported on tablet devices. This field is disabled when the ML Type field contains Character. A rule exists on this field that will compare the value you enter in the Maximum Valid Value field with the value you enter in the Minimum Valid Value field. If you enter a value in the Maximum Valid Value field that is less than the value in the Minimum Valid Value field, a message will appear, indicating that the value must be greater than the value in the Minimum Valid Value. |
Minimum Target Value | Numeric | A number representing the lowest target reading value that is acceptable for the Checkpoint |
On the datasheet, this field appears as a text box labeled Minimum Target Value, in which you can enter a number. Together, the value stored in this field and the value stored in the Maximum Target Value field define a target range that appear son the More Information screen on the mobile device. Note: This feature is not supported on tablet devices.
This field is disabled when the value in the ML Type field contains Character. A rule exists on this field that will compare the value you enter in the Maximum Target Value field with the value you enter in the Minimum Target Value field. If you enter a value in the Minimum Target Value field that is greater than the value in the Maximum Target Value field, a message will appear, indicating that the value must be less than the value in the Maximum Target Value. |
Minimum Valid Value | Numeric | A number representing the lowest reading value that is acceptable for the Checkpoint | On the datasheet, this field appears as a text box labeled Minimum Valid Value, in which you can enter a number. This value is used by the mobile device to check the reading value that is entered by the device user and display a message if the value they enter is lower than this value. Together, this value and the value in the Maximum Valid Value field define the valid reading value parameters for a Checkpoint. Note: This feature is not supported on tablet devices. This field is disabled when the ML Type field contains Character. A rule exists on this field that will compare the value you enter in the Maximum Valid Value field with the value you enter in the Minimum Valid Value field. If you enter a value in the Minimum Valid Value field that is greater than the value in the Maximum Valid Value field, a message will appear, indicating that the value must be less than the value in the Maximum Valid Value. |
ML Type | Character | The type of data that users can enter when creating a Reading linked to the Measurement Location | On the datasheet, this field appears as a list labeled ML Type and contains the following values:
|
More Information | Character | Additional instructions about the Checkpoint that you want to be displayed on the Data Collection page | This field appears on the Data Collection page and is labeled Additional Instructions on that page. |
Product | Character | The product produced by the piece of equipment that is associated with this Checkpoint | On the datasheet, this field appears as a cell. You can enter a value directly in the Product cell. You can use this field to differentiate which Checkpoint is relevant depending on the current product for equipment that is used to produce multiple products. The field would be used as a filter in a customized download query to include only the relevant Checkpoints depending on the current product. This feature is only supported for Windows CE mobile devices that use a customizable download query. Note: This feature is not supported on tablet devices. |
Related Asset Id | Character | The ID of the Equipment or Functional Location to which you want to link the Measurement Location | On the datasheet, this field appears as a text box labeled Asset ID. When the Measurement Location is linked to:
|
Related Ref Doc Image Key | Numeric | The entity key of a reference document | On the datasheet, this field appears as a text box labeled Checkpoint Image in which you can enter or select a reference document image that will be downloaded to a device and displayed when you access a checkpoint in Rounds Data Collection. |
Requires Equipment Shutdown | Logical | Indicates whether the equipment requires shutdown | On the datasheet, this field appears as a check box, which is cleared by default. |
Scan ID | Character | The ID of the barcode that identifies the Checkpoint | This field is enabled only when you are working with a Measurement Location that is linked directly to a Route, (i.e., it is disabled when you are working with a Measurement Location that is linked to a predecessor Checkpoint Condition). If you have assigned a Scan ID to the Equipment or Functional Location linked to the Measurement Location, the Scan ID field on the Measurement Location datasheet will be populated with the same Scan ID that appears in the Equipment or Functional Location. |
Status | Character | The status of the Measurement Location | On the datasheet, this field appears as a list labeled Status and contains the following values:
You can select a value from the list. This field contains the value Active by default. Inactive Measurement Locations will not appear on Data Collection pages. |
Template | Character | The Measurement Location Template that you want to use to populate fields in the Measurement Location | On the datasheet, this field appears as a list displaying the Template IDs of the Measurement Location Template records in your database. When you select a value, other fields in the record will be populated automatically based on the values in that template. After you save a Measurement Location, the Content GUID of the selected Measurement Location Template record is stored in the Template field, and the field is disabled. |
Unit of Measure | Character | The unit of measure that users can specify when entering a numeric reading value for the Checkpoint | On the datasheet, this field appears as a list labeled Unit of Measure. You can select a value from the list. This field is disabled if the ML Type field contains the value Character. Note:
Rounds does not use the Units of Measure Conversions feature. The system code table UOME is the only source for populating drop-down list values within UOM fields. The UOM field for a Measurement Location contains all the values from the UOME system code table, sorted by their descriptions. |
Measurement Location Template Records
Measurement Location Template records store details about measurement location templates that can be used to create Checkpoints on a Route. This topic provides an alphabetical list and description of the fields that exist for the Measurement Location Template family. The information in the table reflects the baseline state and behavior of these fields. This list is not comprehensive.
This family is enabled for site filtering, which means that records in this family can be assigned to a specific site and will 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 Sites section of the documentation.
Field | Data Type | Description | Behavior and Usage |
---|---|---|---|
Allowable Values | Character | The values the user can select when entering a reading for the Checkpoint created from the template | On the datasheet, this field appears as a list labeled Allowable Values and contains all the values in the Value field in the Operator Rounds Allowable Values family whose type and category values match the values stored in the ML Type and Category lists in the Measurement Location Template. You can select values in this list to indicate that the corresponding allowable value should appear on the device for a Checkpoint created from the template. For example, suppose you select Character in the ML Type list and Pump Check in the Category list in a Measurement Location Template. If four allowable values contain the value Character in their Type fields and Pump Check in their Category fields, the Allowable Values list on the Measurement Location Template datasheet will contain the values in the Value fields of those four allowable values. The values in this list are also used to populate the Numeric and Character lists on the Limit Values section of the ML Task View datasheet. These values are used to set up alerts that will be displayed to device users if they enter a certain reading value. On the Action section of the ML datasheet, the user can add Action Taken values to a list for any Measurement Location Template separately for the Limit Values. |
Allowable Values Temp | Character | Temporary field used by family policies to store values as they are being updated | By default, this field does not appear on the datasheet, and users cannot enter values into this field. The field is latent unless the Before Update and After Update Family Policies in the Operator Rounds Allowable Values family are activated. If these family policies are activated, this field temporarily stores Allowable Value changes during an update. |
Category | Character | The category to which the Checkpoint belongs | On the datasheet, this field appears as a list labeled Category and contains the values that are defined in the Category field in the Operator Rounds Allowable Values family whose type matches the value that is stored in the ML Type field in the Measurement Location. You can select a value from the list. For example, if you select Character in the ML Type list in a Measurement Location and four allowable values contain the value Character in their Type fields, the Category list on the Measurement Location datasheet will contain the values in the Category field of those four allowable values. |
Category Temp | Character | Temporary field used by family policies to store values as they are being updated | By default, this field does not appear on the datasheet, and users cannot enter values into this field. The field is latent unless the Before Update and After Update Family Policies in the Operator Rounds Allowable Values family are activated. If these family policies are activated, this field temporarily stores Category changes during an update. |
Checkpoint Locked | Boolean | Indicates whether a Checkpoint will be locked on a Windows Mobile Device until the device user scans the associated barcode |
On the datasheet, this field appears as a check box labeled Scan to Unlock?. On the datasheet, this field appears as a check box labeled Scan to Unlock?. This field is populated automatically in new Measurement Locations that are created from the Measurement Location Template. If you modify this value, it is not updated automatically in Measurement Locations that were created from the Measurement Location Template. When this field is set to:
Note:
|
Content Guid Char | Character | Character value of system field Content GUID |
You can use this field to create a query that links a Checkpoint to its related Checkpoint template. This field is inherited from the Checkpoint Template family. |
Description | Character | A description of the template | On the datasheet, this field appears as a text box labeled ML Description. In this box, you can enter a description of the action users will be completing when they enter readings for this Checkpoint (e.g., Pump Check, Vibration Check, or Temperature Check). This is a required field. |
Include as Health Indicator Source | Boolean | Indicates whether a potential health indicator source is used to create health indicators. | In the datasheet, this field appears as a check box labeled Include as Health Indicator Source. When this check box is selected, health indicators are created for the selected source. When the check box is cleared, health indicators are not created for the selected source. |
Maximum Target Value | Numeric | A number representing the highest target reading value that is acceptable for the Checkpoint |
On the datasheet, this field appears as a text box labeled Maximum Target Value, in which you can enter a number. Together, the value stored in this field and the value stored in the Minimum Target Value field define a target range that appears on the More Information screen on a Windows Mobile device. Note: This feature is not supported on tablet devices.
This field is disabled when the value in the ML Type field contains Character. A rule exists on this field that will compare the value you enter in the Maximum Target Value field with the value you enter in the Minimum Target Value field. If you enter a value in the Maximum Target Value field that is less than the value in the Minimum Target Value field, a message will appear, indicating that the value must be greater than the value in the Minimum Target Value. |
Maximum Valid Value | Numeric | A number representing the highest reading value that is acceptable for the Checkpoint |
On the datasheet, this field appears as a text box labeled Maximum Valid Value, in which you can enter a number. This value is used by the mobile device to check the reading value that is entered by the device user and display a message if the value they enter is higher than this value. Together, this value and the value in the Minimum Valid Value field define the valid value parameters for a reading. Note: This feature is not supported on tablet devices.
This field is disabled when the ML Type field contains Character. A rule exists on this field that will compare the value you enter in the Maximum Valid Value field with the value you enter in the Minimum Valid Value field. If you enter a value in the Maximum Valid Value field that is less than the value in the Minimum Valid Value field, a message will appear, indicating that the value must be greater than the value in the Minimum Valid Value. |
Minimum Target Value | Numeric | A number representing the lowest target reading value that is acceptable for the Checkpoint |
On the datasheet, this field appears as a text box labeled Minimum Target Value, in which you can enter a number. Together, the value stored in this field and the value stored in the Maximum Target Value field define a target range that appears on the More Information screen on the mobile device. Note: This feature is not supported on tablet devices.
This field is disabled when the value in the ML Type field contains Character. A rule exists on this field that will compare the value you enter in the Maximum Target Value field with the value you enter in the Minimum Target Value field. If you enter a value in the Minimum Target Value field that is greater than the value in the Maximum Target Value field, a message will appear, indicating that the value must be less than the value in the Maximum Target Value. |
Minimum Valid Value | Numeric | A number representing the lowest reading value that is acceptable for the Checkpoint |
On the datasheet, this field appears as a text box labeled Minimum Valid Value, in which you can enter a number. This value is used by the mobile device to check the reading value that is entered by the device user and display a message if the value they enter is lower than this value. Together, this value and the value in the Maximum Valid Value field define the valid reading value parameters for a Checkpoint. Note: This feature is not supported on tablet devices.
This field is disabled when the ML Type field contains Character. A rule exists on this field that will compare the value you enter in the Maximum Valid Value field with the value you enter in the Minimum Valid Value field. If you enter a value in the Minimum Valid Value field that is greater than the value in the Maximum Valid Value field, a message will appear, indicating that the value must be less than the value in the Maximum Valid Value. |
ML Type | Character | The type of data that users can enter when creating a Reading linked to the Measurement Location |
On the datasheet, this field appears as a list labeled ML Type and contains the following values:
|
More Information | Character | Additional instructions about the Checkpoint that you want to be displayed on the Data Collection page |
This field appears on the Data Collection page and is labeled Additional Instructions on that page. |
Non-Compliance Date Interval | Numeric | It is the Non Compliance Date Interval (in days) added to Next Date to get the Non-Compliance Date |
This field is not populated automatically. If Non Compliance Date Interval is absent, then Next Compliance Date value is populated as: Next Date + Schedule Interval. |
Product | Character | The product produced by the piece of equipment that is associated with this Checkpoint |
On the datasheet, this field appears as a cell. You can enter a value directly in the Product cell. You can use this field to differentiate which Checkpoint is relevant depending on the current product for equipment that is used to produce multiple products. The field would be used as a filter in a customized download query to include only the relevant Checkpoints depending on the current product. This feature is only supported for Windows CE mobile devices that use a customizable download query. Note: This feature is not supported on tablet devices.
|
Requires Equipment Shutdown | Boolean | Indicates whether the equipment requires shutdown |
On the datasheet, this field appears as a check box, which is cleared by default. |
Schedule | Character | The schedule by which you want to take readings for the Measurement Location Template | This field contains a ellipsis button that you can select to view the Schedule window, where you can define the schedule for the Measurement Location Template. |
Status | Character | The status of the Measurement Location |
On the datasheet, this field appears as a list labeled Status and contains the following values:
You can select a value from the list. This field contains the value Active by default. Inactive Measurement Locations will not appear on Data Collection pages. |
Template ID | Character | The ID for the template | On the datasheet, this field appears as a text box labeled Template ID. You can enter an ID for the template. This value must be unique. A rule exists on this field that will check whether the value that you enter in Template ID field is already used in a different Measurement Location Template. If the value is already used in a Measurement Location Template, a message will appear indicating that the ID already exists. |
Unit of Measure | Character | The unit of measure that users can specify when entering a numeric reading value for the Checkpoint | On the datasheet, this field appears as a list labeled Unit of Measure. You can select a value from the list. This field is disabled if the ML Type field contains the value Character. Note:
Rounds does not use the Units of Measure Conversions feature. The system code table UOME is the only source for populating drop-down list values within UOM fields. The UOM field for a Measurement Location contains all the values from the UOME system code table, sorted by their descriptions. |
Operator Rounds Recommendation Records
Operator Rounds Recommendation records are created by mobile device users to communicate maintenance or follow-up inspection requirements based on the observed conditions of Checkpoints on a Route. Recommendations can be created linked to a specific Checkpoint and the related asset, or as standalone recommendations that are linked to the Equipment or Functional Location only.
This family is enabled for site filtering, which means that records in this family can be assigned to a specific site and will 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 Sites section of the documentation.
This topic provides an alphabetical list and description of the fields that exist for the Operator Rounds Recommendation family. The information in the table reflects the baseline state and behavior of these fields. This list is not comprehensive; instead, it is limited to field behavior that differs from General Recommendation fields.
Field | Data Type | Description |
---|---|---|
Assigned To | Text | The user to which the recommendation is assigned. This field appears in the Recommendations section of the RDC Overview page. |
Created from Measurement Location | Character | The Measurement Location for which the recommendation was created |
Created from Measurement Location Asset | Numeric | The asset that is associated with the Measurement Location for which the recommendation was created |
Created On | Date | The date and time on which the recommendation was created. This field appears in the Recommendations section of the RDC Overview page. |
Description | Text | The text that appeared in the Description cell when the Recommendation was saved on the mobile device |
Headline | Text | The text that appeared in the Headline cell when the Recommendation was saved on the mobile device |
Measurement Location Entity Key | Numeric | The Entity Key of the Measurement Location for which the recommendation was created |
Recommendation ID | Numeric |
A value that identifies the recommendation record |
Source ML Description | Text | For recommendations, other than standalone recommendations created on a mobile device, this field is populated automatically with the value that is stored in the ML or LR Description field in the Measurement Location or Lubrication Requirement record for which the recommendation was created. |
Type | Text | The type of recommendation (for example, Operator Rounds Recommendation). This field appears in the Recommendations section of the RDC Overview page. This field is populated automatically. |
Operator Rounds Recommendation In Error Records
Operator Rounds Recommendation in Error records are created when a recommendation saved on a device fails to upload to APM for any reason. Operator Rounds Recommendation in Error records contain values from the data that was entered on the device.
The information in the topic reflects the baseline state and behavior of these fields. This list is not comprehensive; instead, it is limited to field behavior that differs from Operator Rounds Recommendation fields.
This family is enabled for site filtering, which means that records in this family can be assigned to a specific site and will 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 Sites section of the documentation.
Field | Data Type | Description |
---|---|---|
Recommendation Error Details | Text | On the Operator Rounds Recommendation in Error datasheet, this read-only field contains the details of the error that occurred when creating the recommendation fails. |
Reading Records
Reading records store details about readings taken at Checkpoints on a Route. This topic provides an alphabetical list and description of the fields that exist for the Reading family. The information in the table reflects the baseline state and behavior of these fields. This list is not comprehensive.
This family is enabled for site filtering, which means that records in this family can be assigned to a specific site and will 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 Sites section of the documentation.
Field | Data Type | Description | Behavior and Usage |
---|---|---|---|
Action Taken | Character | The action taken based on a reading | You can enter a value in this field. |
Asset ID | Character | The ID of the asset associated with the Checkpoint |
When the reading is linked to:
|
Comment | Character | A comment about the reading | This field is populated with the text that a user entered in the Comments text box, which appears when taking a reading. |
Reading Taken Date | Date | The date the reading was taken | This field is populated automatically with the date on which you took the reading. |
Reading Value Character | Character | The character value of the reading | You can enter a value in this field. |
Reading Value Numeric | Numeric | The numeric value of the reading | You can enter a value in this field. |
Related ML Entity Key | Numeric | The entity key of the associated Checkpoint | This field is populated automatically by the associated Checkpoint. |
Related Route History Entity Key | Numeric | The entity key of the associated route history | This field is populated automatically by the current open route history record. |
Status | Character | The status of the reading | This field is populated automatically with Complete, Ignored, or Non Compliant, based on the schedule of the Checkpoint. |
Taken by | Character | The user who recorded the reading | This field is populated with the user that took the reading. |
Unit of Measure | Character | The unit of measure that users can specify when entering a numeric value for the reading | This field appears as a list populated by the UOME System Code Table. This field is disabled if the value in the ML Type field is set to Character, or if the value in the LR Type field is set to Check Off. Note:
Rounds does not use the Units of Measure Conversions feature. The system code table UOME is the only source for populating drop-down list values within UOM fields. The UOM field for a Measurement Location contains all the values from the UOME system code table, sorted by their descriptions. The UOM field for a Lubrication Requirement contains a subset of values from the UOME system code table based on specific reference values from the MI_LM_REFERENCES system code table. |
Rounds Sequence Information Records
Rounds Sequence Information records store information about the order in which Checkpoints appear in a route.
This topic provides an alphabetical list and description of the fields that exist for the Rounds Sequence Information family. 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 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 Sites section of the documentation.
Field | Data Type | Description | Behavior and Usage |
---|---|---|---|
Checkpoint or Condition Key | Numeric | The Entity Key of the Checkpoint or condition for which this record was created | This field is populated automatically. |
Rounds Rank | Numeric | The location of the Checkpoint or condition within the Route hierarchy | This field is populated automatically and should not be modified. |
Route Key | Numeric | The Entity Key of the Route containing the Checkpoint | This field is populated automatically. |
Sequence | Numeric | The position the Checkpoint appears in a Route | This field is populated automatically. |
Route Records
This topic provides an alphabetical list and description of the fields that exist for the Route family. The information in the table reflects the baseline state and behavior of these fields. This list is not comprehensive.
This family is enabled for site filtering, which means that records in this family can be assigned to a specific site and will 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 Sites section of the documentation.
Field | Data Type | Description | Behavior and Usage |
---|---|---|---|
Last Date | Date | The date on and time at which the Route status was changed to Finished | If the Route has a Schedule, this field is populated automatically after the Route is marked done and uploaded to APM. |
Next Date | Date | The date on and time at which the readings for the Route become due | If the Route has a Schedule, this field is populated automatically based on the values in the Schedule field and the Last Date field. If the Last Date field is empty, the value in the Next Date field is calculated using the schedule and the current date and time. |
Route Description | Character | A description of the Route, which appears in the Description column in the Routes grid |
On the datasheet, this field appears as a text box labeled Route Description, in which you can enter a description of the Route. |
Route ID | Character | A name for the Route |
The value in this field is used to identify the Route in the left pane, Route section, and on the mobile device. |
Route Scan ID | Numeric | The scan ID that you want to assign to the Route | On the datasheet, this field appears as a text box labeled Route Scan ID, in which you can type the scan ID. |
Sequence | Text | The sequence of Checkpoints and their successors on a Route | This field is populated automatically and does not appear on the Route datasheet. It is disabled by default and should not be enabled or modified. |
Schedule | Character | The schedule by which you want to take readings for the Route | This field contains a ellipsis button that you can select to view the Schedule window, where you can define the schedule for the associated Route. |
Status | Character | The status of the Route |
On the datasheet, this field appears as a list labeled Status and contains the following values:
This field contains the value Inactive by default. Routes will only be available in the Route Data Collection module if the Status is Active. |
Route History Records
Route History records store information on all the Measurement Location readings taken, and also about the completion of a Route. This topic provides an alphabetical list and description of the fields that exist for the Route History family. The information in the table reflects the baseline state and behavior of these fields. This list is not comprehensive.
This family is enabled for site filtering, which means that records in this family can be assigned to a specific site and will 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 Sites section of the documentation.
Field | Data Type | Description | Behavior and Usage |
---|---|---|---|
Close Date | Date | The date and time on which the Route status was changed to Finished | This field is populated automatically after the Route is marked done. |
Closed By | Text | User ID of person marking the Route done is saved to the field | This field is populated with the User id of the person marking the Route done. The field is formatted to show the user name. |
Comments | Text | Comments about the Route | This field is populated with the text that a user entered in the Comments text box, which appears when marking the Route as done. |
Readings Expected | Number | The number of Checkpoints in the associated Route | This field is populated automatically when the user has commenced taking readings on the Route. The value will continue to be updated automatically as readings are collected, until the Route is marked done. If the Route contains conditional Checkpoints, this field accounts only for the Checkpoints whose conditions were met. |
Readings Taken | Number | The number of Checkpoints in the associated Route for which readings were taken | This field is populated automatically when the user has commenced taking readings on the Route. The value will continue to be updated automatically as readings are collected, until the Route is marked done. |
Recommendations Raised | Number | The number of recommendations created for route | This field is populated automatically and displays the number of recommendations created for route. The value will continue to be updated automatically as recommendations are created, until the Route is marked done. |
Status | Character | The status of the Route | This field is populated with In Progress if a user has commenced taking readings, but has not yet marked the Route as done. After the Route has been marked done the field will be populated with Finished. |