Contracts
- Last UpdatedAug 01, 2024
- 6 minute read
The following table lists the fields which are available in the Contracts data model.
Any contract and contractor custom fields which have been configured by the Administrator are also available and can be used according to their type. The field names for custom fields are prefixed as follows:
-
Contract_Custom_Field_, e.g. Contract_Custom_Field_HSSE
-
Contractor_Custom_Field_, e.g. Contractor_Custom_Field_Local
If using a third-party application such as PowerBI, we recommend you select only the required fields. Many fields in the Analytics data models are duplicated and can be excluded from queries; see Duplicated fields for more information.
Warning If the custom field name contains any characters that are not alphanumeric, these are replaced by underscores in the Analytics data model.
For example:
• The contract custom field "Doc. Ref" has the Analytics field name of Contract_Custom_Field_Doc__Ref - the . and space are replaced by _
• The contractor custom field "VAT#" has the Analytics field name of Contractor_Custom_Field_VAT_ - the # is replaced by _
Note The base currency of the data is configured when AVEVA Contract Risk Management Analytics is installed.
Note For DateTime fields, only the date is stored. The time portion of the value of DateTime fields is therefore always 00:00.
|
Field name |
Type |
Description |
Values |
Data type and size |
Nullable |
|
ContractName |
String |
The name of the contract. |
nvarchar(510) |
No |
|
|
ContractReference |
String |
The unique reference for the contract. |
nvarchar(510) |
No |
|
|
ContractType |
String |
The type of the contract. |
|
nvarchar(510) |
No |
|
ContractState |
String |
The state of the contract. |
|
nvarchar(100) |
No |
|
ContractCategory |
String |
The category of the contract. |
nvarchar(510) |
No |
|
|
IsDeleted |
String |
Indicates whether the contract is in the Recycle Bin. |
|
nvarchar(100) |
No |
|
AwardDate |
DateTime |
The date that the contract was awarded. |
datetime |
Yes |
|
|
StartDate |
DateTime |
The start date of the contract. |
datetime |
Yes |
|
|
OriginalEndDate |
DateTime |
The end date of the contract specified when the contract was created. |
datetime |
Yes |
|
|
PlannedEndDate |
DateTime |
The current planned end date of the contract. |
datetime |
Yes |
|
|
ContractCurrency |
String |
The base currency of the contract. |
nvarchar(510) |
No |
|
|
AwardValue |
Decimal |
The award value of the contract in the contract currency. |
money(19,4) |
Yes |
|
|
AwardValueBase |
Decimal |
The award value of the contract in the base currency of the data. |
money(19,4) |
Yes |
|
|
ApprovedBudgetValue |
Decimal |
The approved budget of the contract in the contract currency. |
money(19,4) |
Yes |
|
|
ApprovedBudgetValueBase |
Decimal |
The approved budget of the contract in the base currency of the data. |
money(19,4) |
Yes |
|
|
InitialNotToExceed |
Decimal |
The Initial Not to Exceed value of the contract in the contract currency. |
money(19,4) |
Yes |
|
|
InitialNotToExceedBase |
Decimal |
The Initial Not to Exceed value of the contract in the base currency of the data. |
money(19,4) |
Yes |
|
|
NotToExceed |
Decimal |
The Not to Exceed value of the contract in the contract currency. |
money(19,4) |
Yes |
|
|
NotToExceedBase |
Decimal |
The Not to Exceed value of the contract in the base currency of the data. |
money(19,4) |
Yes |
|
|
ApprovedExpenditure |
Decimal |
The approved expenditure value of the contract in the contract currency. |
money(19,4) |
Yes |
|
|
ApprovedExpenditureBase |
Decimal |
The approved expenditure value of the contract in the base currency of the data. |
money(19,4) |
Yes |
|
|
PendingExpenditure |
Decimal |
The pending expenditure value of the contract in the contract currency. |
money(19,4) |
Yes |
|
|
PendingExpenditureBase |
Decimal |
The pending expenditure value of the contract in the base currency of the data. |
money(19,4) |
Yes |
|
|
PotentialExpenditure |
Decimal |
The potential expenditure value of the contract in the contract currency. |
money(19,4) |
Yes |
|
|
PotentialExpenditureBase |
Decimal |
The potential expenditure value of the contract in the base currency of the data. |
money(19,4) |
Yes |
|
|
ApprovedFinancialCommitment |
Decimal |
The approved change value plus the award value of the contract in the contract currency. |
money(19,4) |
Yes |
|
|
ApprovedFinancialCommitmentBase |
Decimal |
The approved change value plus the award value of the contract in the base currency of the data. |
money(19,4) |
Yes |
|
|
PendingFinancialCommitment |
Decimal |
The pending commitment value of the contract in the contract currency. |
money(19,4) |
Yes |
|
|
PendingFinancialCommitmentBase |
Decimal |
The pending commitment value of the contract in the base currency of the data. |
money(19,4) |
Yes |
|
|
PotentialFinancialCommitment |
Decimal |
The potential commitment value of the contract in the contract currency. |
money(19,4) |
Yes |
|
|
PotentialFinancialCommitmentBase |
Decimal |
The potential commitment value of the contract in the base currency of the data. |
money(19,4) |
Yes |
|
|
ApprovedContractChanges |
Decimal |
The approved change value of the contract in the contract currency. |
money(19,4) |
Yes |
|
|
ApprovedContractChangesBase |
Decimal |
The approved change value of the contract in the base currency of the data. |
money(19,4) |
Yes |
|
|
HasActiveAlerts |
String |
Indicates whether the contract has any active alerts. |
nvarchar(6) |
No |
|
|
ProjectDepartmentName |
String |
The reference and name of the project/dept in which the contract is located. |
nvarchar(300) |
No |
|
|
BusinessUnitId |
Int32 |
The unique ID of the business unit in which the contract is located. |
Integer |
No |
|
|
CountryName |
String |
The country in which the contract operates. |
nvarchar(510) |
No |
|
|
ContractorRef |
String |
The unique reference for the contractor. |
nvarchar(40) |
No |
|
|
ContractorName |
String |
The name of the contractor. |
nvarchar(1022) |
No |
|
|
ParentFrameworkAgreementName |
String |
Call off contracts only. The name of the parent framework agreement. |
nvarchar(510) |
No |
|
|
ParentFrameworkAgreementReference |
String |
Call off contracts only. The unique reference for the parent framework agreement. |
nvarchar(510) |
No |
|
|
CompanyRepresentative |
String |
The name of the company user assigned to the Company Representative contract role. |
nvarchar(302) |
No |
|
|
ContractOwner |
String |
The name of the company user assigned to the Contract Owner contract role. |
nvarchar(302) |
No |
|
|
ContractorRepresentative |
String |
The name of the contractor user assigned to the Contractor Representative contract role. |
nvarchar(302) |
No |
|
|
TotalCommitmentExposure |
Decimal |
The total commitment value in the contract currency: AwardValue + PotentialCommitment + PendingCommitment + ApprovedCommitment |
money(19,4) |
Yes |
|
|
TotalCommitmentExposureBase |
Decimal |
The total commitment value in the base currency of the data: AwardValueBase + PotentialCommitmentBase + PendingCommitmentBase + ApprovedCommitmentBase |
money(19,4) |
Yes |
|
|
TotalExpenditureExposure |
Decimal |
The total expenditure in the contract currency: PotentialExpenditure + PendingExpenditure + ApprovedExpenditure |
money(19,4) |
Yes |
|
|
TotalExpenditureExposureBase |
Decimal |
The total expenditure in the base currency of the data: PotentialExpenditureBase + PendingExpenditureBase + ApprovedExpenditureBase |
money(19,4) |
Yes |
|
|
ContractCreatedBy |
String |
The name of the user who created the contract. |
nvarchar(1320) |
No |
|
|
ContractCreatedOn |
DateTime |
The date and time that the contract was created. |
datetime |
No |
|
|
ContractClosedOn |
DateTime |
The date and time that the contract was closed. |
datetime |
Yes |
|
|
BusinessUnitName |
String |
The name of the business unit in which the contract is located. |
nvarchar(300) |
No |
|
|
ContractAdministrators |
String |
A list of users assigned to the Contract Administrator contract role. |
nvarchar(8000) |
Yes |
|
|
BreakdownItemCommitment |
Decimal |
The sum of the approved commitment of all breakdown items in the contract, in the contract currency. |
money(19,4) |
Yes |
|
|
BreakdownItemCommitmentBase |
Decimal |
The sum of the approved commitment of all breakdown items in the contract, in the base currency of the data. |
money(19,4) |
Yes |
|
|
BreakdownItemCommitmentDifference |
Decimal |
The difference between the approved contract commitment and the sum of the approved commitment of all breakdown items in the contract, in the contract currency. |
money(19,4) |
Yes |
|
|
BreakdownItemCommitmentDifferenceBase |
Decimal |
The difference between the approved contract commitment and the sum of the approved commitment of all breakdown items in the contract, in the base currency of the data. |
money(19,4) |
Yes |
|
|
ContractCommitmentFullyAllocated |
String |
Indicates whether the contract commitment is fully allocated to breakdown and line items:
|
|
nvarchar(6) |
No |
|
LineItemCommitment |
Decimal |
The sum of the approved commitment of all line items in the contract, in the contract currency. |
money(19,4) |
Yes |
|
|
LineItemCommitmentBase |
Decimal |
The sum of the approved commitment of all line items in the contract, in the base currency of the data. |
money(19,4) |
Yes |
|
|
DaysRemainingOnContract |
Int32 |
The difference between the current date and the Planned End date of the contract. |
Integer |
Yes |
|
|
MethodOfCommunication |
String |
Indicates whether the contractor is using the Contractor Portal (Contractor to Communicate via Extranet) or another method of communication (Contractor to Communicate via other means). |
|
nvarchar(100) |
No |
|
ProjectReference |
String |
The unique reference of the project/dept in which the contract is located. |
nvarchar(40) |
No |