| Name | Rate_Schedule_Detail |
|---|---|
| Entity Type | Table |
| Description | Details about the rate for payments that are made according to a rate schedule. Includes details about the duration or condition under which payments are made, the frequency of payment, and the amount of the rate. |
| Submodel | Obligation |
| Entity Scope | Project |
| Primary Key | Id |
| Natural Key | |
| Generalizations | Entity , IT_Object , Tracked_Object |
| Specializations |
| Name | Value Domain | Property / Storage Unit | Description | Required / Default | Type |
|---|---|---|---|---|---|
| Currency_Code | R_Currency |
|
The currency in which the rate amount is expressed. | No |
VARCHAR2(64) |
| Duration_UOM | R_Transient_Period |
|
The unit of measure in which the Rate_Duration_Start and Rate_Duration_End values are expressed. For example, if the rate is valid for years 1 through 5 of an obligation, the value of "1" would be in Rate_Duration_Start, "5" would be in Rate_Duration_End, and "Yearly" would be in Duration_UOM. Note, if the time period during which the rate is conditional and is not expressed in terms of a duration (for example, "before discovery"), this attribute should be left blank and Rate_Condition_Text should be populated. | No |
VARCHAR2(64) |
| End_Date | DATE | NA |
Date on which the rate was no longer a part of the rate schedule. | No |
DATE |
| Existence_Kind | REF_EXISTENCE_KIND | NA |
A reference value that describes the state of existence in the lifecycle of the entity, for example, Planned, Predicted, Required, Simulated, and Actual. | Yes Actual |
VARCHAR2(64) |
| GUID | STRING128 | NA |
Globally Unique IDentifier for an instance of a class. USAGE NOTES: There are two cases: 1) GUID is not populated or used; and 2) it is populated with a value that is globally unique. If the GUID is populated there are two means of doing so for a given project: 2a) Seabed automatically generates and populates the GUID when an instance is created (valid only on Oracle based systems); and 2b) the GUID is generated and populated by an application (other than Seabed) on instance creation. Whether Seabed automatically generates GUIDs for a project is determined by the Auto_GUID flag in SDS_Account. Note that techniques 2a and 2b can coexist in the same project. When GUIDs are automatically generated an application can override the automatically generated GUID with its own GUID by simply supplying the GUID value. Applications that generate their own GUIDs and populate the GUID column will function correctly on projects which have automatic GUID generation turned on. | No |
VARCHAR2(128) |
| Id | ID | No_Unit |
Unique identifier for this entity. | Yes |
NUMBER(38) |
| Insert_Date | DATE | NA |
Date the entity was created in the repository | No |
DATE |
| Insert_User | STRING64 | NA |
The name of the user responsible for the creation of this entity in the repository. | No |
VARCHAR2(64) |
| Name | ENTITY_NAME | NA |
The name given to any object or data item, e.g. name of Well, name of Field, etc. | No |
VARCHAR2(255) |
| Original_Source | STRING64 | NA |
The name of the person, Organization or project source that originally provided this entity, e.g. "IHS-EnergyData" or "FinderUpper Stratton Deeper Pool 15" | No |
VARCHAR2(64) |
| Payment_Frequency | R_Transient_Period |
|
The frequency with which the payment of the rate must be made during the time when the Rate Condition is true | Yes |
VARCHAR2(64) |
| Produced_By | STRING64 | NA |
The name of application role that created the entity, for data created programmatically. | No |
VARCHAR2(64) |
| Rate_Amount | double | No_Unit |
The monetary amount of the rate per the value stored in Rate_Amount_UOM. If no value is stored in Rate_Amount_UOM, then the rate amount is a flat amount. | No |
NUMBER |
| Rate_Amount_UOM | R_Unit |
|
The unit in which the Rate_Amount is stored. I.e., percentage, per hectare, per km, per acre, etc. If no value is stored in Rate_Amount_UOM, then the rate amount is a flat amount. | No |
VARCHAR2(64) |
| Rate_Condition_Text | REMARKS_STR | NA |
If the time period during which a rate is valid is expressed by a condition, this attribute stores the value of that condition. For example, if the rate is valid before discovery, you could store "before discovery" in this column. Alternatively, you could also specify a SQL query that can be used to determine when the rate becomes effective. Note, if the time period during which the rate is valid is expressed in terms of a duration, you can use Rate_Duration_Start, Rate_Duration_End, and Duration_UOM to specify when the rate is effective. | No |
VARCHAR2(999) |
| Rate_Duration_End | Int8 | No_Unit |
If the time period during which a rate is valid is expressed by a time duration, this attribute stores the value of the end of the time duration, as expressed in Duration_UOM. For example, if the rate is valid for years 1 through 5 of an obligation, the value of "1" would be in Rate_Duration_Start, "5" would be in Rate_Duration_End, and "Yearly" would be in Duration_UOM. Note, if the time period during which the rate is valid is conditional (for example, "before discovery") and is not expressed in terms of a duration, this attribute should be left blank and Rate_Condition_Text should be populated. | No |
INTEGER |
| Rate_Duration_Start | Int8 | No_Unit |
If the time period during which a rate is valid is expressed by a time duration, this attribute stores the value of the start of the time duration, as expressed in Duration_UOM. For example, if the rate is valid for years 1 through 5 of an obligation, the value of "1" would be in Rate_Duration_Start, "5" would be in Rate_Duration_End, and "Yearly" would be in Duration_UOM. Note, if the time period during which the rate is conditional and is not expressed in terms of a duration (for example, "before discovery"), this attribute should be left blank and Rate_Condition_Text should be populated. | No |
INTEGER |
| Rate_Formula | REMARKS_STR | NA |
The formula used to determine the rate amount. May be expressed as a SQL statement if desired. | No |
VARCHAR2(999) |
| Rate_Schedule_Id | Rate_Schedule |
|
The rate schedule under which this rate is paid. | Yes |
NUMBER(38) |
| Rate_Type | R_Rate |
|
The type of rate charged. Examples may include posting fees, expenses, title search, copy charges, rentals etc. | Yes |
VARCHAR2(64) |
| Remarks | STRING2000 | NA |
Any type of remarks added to an entity instance. | No |
VARCHAR2(2000) |
| SDAT_Label | int | No_Unit |
Label used by the security system for entitlements. SDAT is Secure Data Access Technology. | No |
NUMBER(10) |
| Source | STRING64 | NA |
Name of the person or organization responsible for this entitys E and P content and quality. Not the data technologist or IT expert creating the entity, for which see IT_Object.Insert_User and Update_User. | No |
VARCHAR2(64) |
| Start_Date | DATE | NA |
Date on which the rate became a part of the rate schedule. | No |
DATE |
| Update_Date | DATE | NA |
Date of the most-recent modification to the entity. | No |
DATE |
| Update_User | STRING64 | NA |
The name of the user responsible for the last modification to this entity. | No |
VARCHAR2(64) |
| Version | STRING255 | NA |
The form or variant of the entity. | Yes 1 |
VARCHAR2(255) |
| From Entity | Link | Description | Implementation Technique | Required |
|---|---|---|---|---|
| Obligation_Payment | Rate_Schedule_Detail | The rate schedule detail that outlines the duration during which the payment must be made, the conditions during which the payment must be made, the payment amount, the payment frequency, etc. | Restrict | No |
| Link | To Entity | Description | Implementation Technique | Required |
|---|---|---|---|---|
| Currency_Code | R_Currency | The currency in which the rate amount is expressed. | Restrict | No |
| Rate_Type | R_Rate | The type of rate charged. Examples may include posting fees, expenses, title search, copy charges, rentals etc. | Restrict | Yes |
| Rate_Amount_UOM | R_Unit | The unit in which the Rate_Amount is stored. I.e., percentage, per hectare, per km, per acre, etc. If no value is stored in Rate_Amount_UOM, then the rate amount is a flat amount. | Restrict | No |
| Duration_UOM | R_Transient_Period | The unit of measure in which the Rate_Duration_Start and Rate_Duration_End values are expressed. For example, if the rate is valid for years 1 through 5 of an obligation, the value of "1" would be in Rate_Duration_Start, "5" would be in Rate_Duration_End, and "Yearly" would be in Duration_UOM. Note, if the time period during which the rate is conditional and is not expressed in terms of a duration (for example, "before discovery"), this attribute should be left blank and Rate_Condition_Text should be populated. | Restrict | No |
| Payment_Frequency | R_Transient_Period | The frequency with which the payment of the rate must be made during the time when the Rate Condition is true | Restrict | Yes |
| Rate_Schedule | Rate_Schedule | The rate schedule under which this rate is paid. | Cascade | Yes |