Family Field Descriptions | On-Premises APM

Analysis Records

Analysis records store information about the fields in the Analysis family that are used to populate the fields for the Analysis Definition. This topic provides an alphabetical list and description of the fields that exist for the Analysis family and appear on the LCC Analysis 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
Analysis Period Unit	Character	The time for unit period.	The default value for this field is years. This field is required.
Annual Effective Interest Rate	Numeric	The annualized compounding interest rate.	This value must be a positive number. This field is required.
Annual Escalation Rate	Numeric	The current price or value minus the initial cost or value in a one-year period, divided by the initial price.	This value must be a positive number. This field is required.
Annual Nominal Interest Rate	Numeric	The stated interest rate of a given loan.	This value must be a positive number. This field is required.
Assumptions	Text	User entered field describing any/all relevant Assumptions.	Text is entered in the Assumptions field.
Constraints	Text	User entered field describing any/all Constraints.	Text is entered in the Constraints field.
Currency	Character	The currency used by your organization.	The default value for this field is US Dollars.
Declining Balance Factor	Numeric	The factor that determines accelerated depreciation in which the amount of depreciation that is charged to an asset declines over time.	The default value for this field is 2, which represents double declining balance depreciation. The value in this field must be a positive number.
Dependencies	Text	User entered field that described any/all dependencies.	Text is entered in the Dependencies field.
Depreciation Method	Character	The method used to determine depreciation of the asset over time.	The value in this field can be: Straight Line Declining Balance Sum of Year's digits This field is required.
Description	Text	User entered field that described any/all descriptions.	Text is entered in the Description field.
End Date	Date	The date on which the analysis ended.	This field is calculated by adding the analysis period to the start date. This field is required.
Interest Rate Type	Character	The type of interest rate, either Simple or Compound, used for the analysis.	This field is required.
Is Fleet Management	Boolean	Identifies whether or not the analysis is used for fleet management.	This field is calculated by your selection when creating a new analysis.
Name	Character	The name of the analysis.	This field is required.
Number of Periods	Numeric	The number of periods (for example, years) which the analysis covers.	This field is required.
Objectives	Text	The objectives for the analysis as defined by your organization.	Text is entered in the Objectives field.
Start Date	Date	The date on which the analysis began.	You can use the Calendar feature to select the date on which the analysis began. This field is required.
Tax Rate	Numeric	The tax rate associated with the analysis.	This value must be a positive number. This field is required.

Cost Records

Cost records store information about the cost data used in LCC. This topic provides an alphabetical list and description of the fields that exist for the Cost family and appear on the LCC Cost 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
Cost Name	Character	The name of the cost.	Text is entered in the Cost Name field.
Cost Type	Character	Determines the type of cost for the record.	The value in this field can be: Capital Operating Calculated
Element Key	Numeric	The Entity Key of the element record.	System Generated field that is hidden by default.
Is Primary	Logical	Indicates whether or not the cost is for the primary element.	This field is required.
Resource Name	Character	The name of the resource.	Text is entered in the Resource Name field to describe the resource.
Scenario Key	Numeric	The Entity Key of the scenario record.	System Generated field that is hidden by default.
Total	Numeric	The total of costs of the cost record.	This field is the sum of the costs of all periods associated with this cost.

Cost Value Records

Cost Value records store information about costs. This topic provides an alphabetical list and description of the fields that exist for the Cost Value 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
Cost	Numeric	The cost associated with the record.	A numeric value is entered in the Cost field.
Cost Key	Numeric	The Entity Key of the cost record.	System Generated field that is hidden by default.
Period Key	Numeric	The Entity Key of the period record.	System Generated field that is hidden by default.
Scenario Key	Numeric	The Entity Key of the scenario record.	System Generated field that is hidden by default.

Element Records

Element records store information about the elements used in scenarios. This topic provides an alphabetical list and description of the fields that exist for the Element 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
Is Primary?	Logical	Indicates whether or not the associated record is the "Primary" Scenario element.	This field is required.
Name	Character	The name of the element record.	This field is required.
Planned Life End	Numeric	The number of units at the end of operation. This field is only available for Fleet Management analyses.	This field is required.
Planned Life Start	Numeric	The number of units at the beginning of operation. This field is only available for Fleet Management analyses.	This field is required.
Quantity	Numeric	The quantity of the element record.	This field is required.
Scenario Key	Numeric	The Entity Key associated with the scenario record.	System Generated field that is hidden by default.

Operating Profile Records

Operating Profile records store information about the fields in the Operating Profile. This topic provides an alphabetical list and description of the fields that exist for the Operating Profile 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
From	Date	The start date for which the profile is applicable.	This field is required.
Name	Character	The name of the profile.	This field is required.
Operating Rate in Percentage	Numeric	The rate of the profile.	This field is required.
Repeat Annually	Logical	Indicates whether or not the operating profile repeats annually.	This field is required.
Scenario Key	Numeric	The Entity Key of the scenario record.	System Generated field that is hidden by default.
To	Date	The end date for which the profile is applicable.	This field is required.

Period Records

Period records store information about the periods in scenarios. This topic provides an alphabetical list and description of the fields that exist for the Period 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
Name	Character	The value used to identify the period.	This field is required.
Scenario Key	Numeric	The Entity Key of the scenario record.	System Generated field that is hidden by default.
Sequence	Numeric	A number indicating the order of the period.	This value begins with 0. This field is required.

Resource Records

Resource records store information about the resources used in scenarios. This topic provides an alphabetical list and description of the fields that exist for the Resource 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
Description	Text	The details of the resource.	Text entered in the Description field to describe the resource.
Name	Character	The value used to identify the resource.	This field is required.
Type	Character	The selection of the type of resource.	The Type must be one of the following values: Labor Part This field is required.
Unit	Character	The selection of the resource unit.	The Unit field is entered. This field is required.
Unit Cost	Numeric	The cost of the unit resource.	This field is required.

Scenario Records

Scenario records are used to determine values in a scenario and store information about the fields in a scenario. This topic provides an alphabetical list and description of the fields that exist for the Scenario 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
Analysis Key	Numeric	The numeric key associated with the Analysis.	System Generated field that is hidden by default.
Description	Text	The details of the scenario.	Text entered in the Description field to describe a scenario.
Internal Rate of Return (IRR)	Numeric	The discount rate used to make the net present value equal 0.	This field is automatically populated.
Is Template	Logical	Identifies whether or not a scenario has been saved as a template.	This field is required.
Measurement Frequency	Character	A value describing the unit of rate capacity. This value is used in conjunction with Monetary Value and Unit of Measure.	The Rate of Measure must be one of the following: Per Year Per Quarter Per Month Per Week Per Day Per Hour This field is required.
Measurement Unit	Character	A value that defines the unit of measure (e.g. gallons, miles, pounds) that is applicable in the Operating Profile.	This value is used in conjunction with Monetary Value and Rate of Measure This field is required.
Name	Character	The value used to identify the scenario.	This field is required.
Net Present Value(NPV)	Numeric	The sum of the present values of incoming and outgoing cash flows over an analysis period.	This field is not required.
Rate Capacity	Numeric	A value describing the maximum rate of measurement (e.g. 5000 gallons/Year).	This field is required.
Total Capital Cost	Numeric	The sum of all Capital Costs in a scenario.	This field is automatically populated. This field is required.
Total Cost of Ownership	Numeric	The sum of all costs required for the ownership of an asset in a scenario.	This field is automatically populated. This field is not required.
Total Operational Cost	Numeric	The sum of all costs needed for asset operations in a scenario.	This field is automatically populated. This field is required.
Value of Unit	Numeric	A monetary value per unit measurement (e.g. $1000/gallon).	This value is used in conjunction with Rate of Measure and Unit of Measure. This field is required.