Donor Agreements
Donor/institution agreement management with SA regulatory compliance.
ahgDonorAgreementPlugin
3
donor_agreement2
donor_agreement_accession0
donor_agreement_classification2
donor_agreement_document32
donor_agreement_history3
donor_agreement_i18n2
donor_agreement_record3
donor_agreement_reminder0
donor_agreement_reminder_log0
donor_agreement_restriction0
donor_agreement_right0
donor_agreement_rights0
donor_provenanceEntity Relationship Diagram
Open Full SizeForeign Key Relationships
| Constraint | Table | Column | References | Referenced Column | |
|---|---|---|---|---|---|
fk_donor_agreement_agreement_type |
donor_agreement |
agreement_type_id | agreement_type |
id | |
fk_donor_agreement_parent |
donor_agreement |
parent_agreement_id | donor_agreement |
id | |
fk_donor_agreement_supersedes |
donor_agreement |
supersedes_agreement_id | donor_agreement |
id | |
fk_donor_agreement_document_agreement |
donor_agreement_document |
donor_agreement_id | donor_agreement |
id | |
fk_agreement_history |
donor_agreement_history |
agreement_id | donor_agreement |
id | |
fk_donor_agreement_i18n |
donor_agreement_i18n |
id | donor_agreement |
id | |
fk_agreement_record_agreement |
donor_agreement_record |
agreement_id | donor_agreement |
id | |
fk_agreement_record_io |
donor_agreement_record |
information_object_id | information_object |
id | |
fk_donor_agreement_reminder_agreement |
donor_agreement_reminder |
donor_agreement_id | donor_agreement |
id | |
fk_donor_agreement_reminder_log_reminder |
donor_agreement_reminder_log |
donor_agreement_reminder_id | donor_agreement_reminder |
id | |
fk_donor_agreement_restriction_agreement |
donor_agreement_restriction |
donor_agreement_id | donor_agreement |
id | |
fk_donor_agreement_right_agreement |
donor_agreement_right |
donor_agreement_id | donor_agreement |
id |
donor_agreement
53 columns
3 rows
| Column | Type | Nullable | Default | Extra | Comment | |
|---|---|---|---|---|---|---|
| PK | id |
int | NOT NULL | - | auto_increment | |
| UQ | agreement_number |
varchar(100) | NOT NULL | - | ||
| FK | donor_id |
int unsigned | NULL | - | ||
actor_id |
int unsigned | NULL | - | |||
| FK | accession_id |
int unsigned | NULL | - | ||
| FK | information_object_id |
int unsigned | NULL | - | ||
repository_id |
int unsigned | NULL | - | |||
| FK | agreement_type_id |
int unsigned | NOT NULL | - | ||
title |
varchar(500) | NOT NULL | - | |||
logo_path |
varchar(500) | NULL | - | |||
logo_filename |
varchar(255) | NULL | - | |||
description |
text | NULL | - | |||
donor_name |
varchar(255) | NULL | - | |||
donor_contact_info |
text | NULL | - | |||
institution_name |
varchar(255) | NULL | - | |||
institution_contact_info |
text | NULL | - | |||
legal_representative |
varchar(255) | NULL | - | |||
legal_representative_title |
varchar(255) | NULL | - | |||
legal_representative_contact |
text | NULL | - | |||
repository_representative |
varchar(255) | NULL | - | |||
repository_representative_title |
varchar(255) | NULL | - | |||
| FK | status |
varchar(85) | NULL |
draft
|
draft, pending_review, pending_signature, active, expired, terminated, superseded | |
agreement_date |
date | NULL | - | |||
| FK | effective_date |
date | NULL | - | ||
expiry_date |
date | NULL | - | |||
| FK | review_date |
date | NULL | - | ||
termination_date |
date | NULL | - | |||
termination_reason |
text | NULL | - | |||
has_financial_terms |
tinyint(1) | NULL |
0
|
|||
purchase_amount |
decimal(15,2) | NULL | - | |||
currency |
varchar(3) | NULL |
ZAR
|
|||
payment_terms |
text | NULL | - | |||
scope_description |
text | NULL | - | |||
extent_statement |
varchar(255) | NULL | - | |||
transfer_method |
varchar(100) | NULL | - | |||
transfer_date |
date | NULL | - | |||
received_by |
varchar(255) | NULL | - | |||
general_terms |
text | NULL | - | |||
special_conditions |
text | NULL | - | |||
donor_signature_date |
date | NULL | - | |||
donor_signature_name |
varchar(255) | NULL | - | |||
repository_signature_date |
date | NULL | - | |||
repository_signature_name |
varchar(255) | NULL | - | |||
witness_name |
varchar(255) | NULL | - | |||
witness_date |
date | NULL | - | |||
internal_notes |
text | NULL | - | |||
is_template |
tinyint(1) | NULL |
0
|
|||
| FK | parent_agreement_id |
int | NULL | - | ||
| FK | supersedes_agreement_id |
int | NULL | - | ||
created_by |
int unsigned | NULL | - | |||
updated_by |
int unsigned | NULL | - | |||
created_at |
datetime | NULL |
CURRENT_TIMESTAMP
|
DEFAULT_GENERATED | ||
updated_at |
datetime | NULL |
CURRENT_TIMESTAMP
|
DEFAULT_GENERATED on update CURRENT_TIMESTAMP |
donor_agreement_accession
7 columns
2 rows
| Column | Type | Nullable | Default | Extra | Comment | |
|---|---|---|---|---|---|---|
| PK | id |
int | NOT NULL | - | auto_increment | |
| FK | donor_agreement_id |
int | NOT NULL | - | ||
| FK | accession_id |
int | NOT NULL | - | ||
is_primary |
tinyint(1) | NULL |
0
|
|||
notes |
text | NULL | - | |||
linked_at |
timestamp | NULL |
CURRENT_TIMESTAMP
|
DEFAULT_GENERATED | ||
linked_by |
int | NULL | - |
donor_agreement_classification
6 columns
0 rows
| Column | Type | Nullable | Default | Extra | Comment | |
|---|---|---|---|---|---|---|
| PK | id |
int | NOT NULL | - | auto_increment | |
| FK | donor_agreement_id |
int | NOT NULL | - | ||
| FK | term_id |
int | NOT NULL | - | ||
applies_to_all |
tinyint(1) | NULL |
0
|
|||
notes |
text | NULL | - | |||
created_at |
timestamp | NULL |
CURRENT_TIMESTAMP
|
DEFAULT_GENERATED |
donor_agreement_document
22 columns
2 rows
| Column | Type | Nullable | Default | Extra | Comment | |
|---|---|---|---|---|---|---|
| PK | id |
int unsigned | NOT NULL | - | auto_increment | |
| FK | donor_agreement_id |
int | NOT NULL | - | ||
| FK | document_type |
varchar(244) | NOT NULL | - | signed_agreement, draft, amendment, addendum, schedule, correspondence, appraisal_report, inventory, deed_of_gift, transfer_form, receipt, payment_record, legal_opinion, board_resolution, donor_id, provenance_evidence, valuation, insurance, photo, other | |
filename |
varchar(255) | NOT NULL | - | |||
original_filename |
varchar(255) | NOT NULL | - | |||
file_path |
varchar(500) | NOT NULL | - | |||
mime_type |
varchar(100) | NULL | - | |||
file_size |
int unsigned | NULL | - | |||
checksum_md5 |
varchar(32) | NULL | - | |||
checksum_sha256 |
varchar(64) | NULL | - | |||
title |
varchar(255) | NULL | - | |||
description |
text | NULL | - | |||
document_date |
date | NULL | - | |||
version |
varchar(50) | NULL | - | |||
is_signed |
tinyint(1) | NULL |
0
|
|||
signature_date |
date | NULL | - | |||
signed_by |
text | NULL | - | |||
is_confidential |
tinyint(1) | NULL |
0
|
|||
access_restriction |
text | NULL | - | |||
uploaded_by |
int unsigned | NULL | - | |||
created_at |
datetime | NULL |
CURRENT_TIMESTAMP
|
DEFAULT_GENERATED | ||
updated_at |
datetime | NULL |
CURRENT_TIMESTAMP
|
DEFAULT_GENERATED on update CURRENT_TIMESTAMP |
donor_agreement_history
8 columns
32 rows
| Column | Type | Nullable | Default | Extra | Comment | |
|---|---|---|---|---|---|---|
| PK | id |
int | NOT NULL | - | auto_increment | |
| FK | agreement_id |
int | NOT NULL | - | ||
| FK | action |
varchar(155) | NOT NULL | - | created, updated, status_changed, approved, renewed, terminated, document_added, document_removed, record_linked, record_unlinked, reminder_sent, note_added | |
old_value |
text | NULL | - | |||
new_value |
text | NULL | - | |||
notes |
text | NULL | - | |||
user_id |
int | NULL | - | |||
| FK | created_at |
datetime | NOT NULL |
CURRENT_TIMESTAMP
|
DEFAULT_GENERATED |
donor_agreement_i18n
8 columns
3 rows
| Column | Type | Nullable | Default | Extra | Comment | |
|---|---|---|---|---|---|---|
| PK | id |
int | NOT NULL | - | ||
| PK | culture |
varchar(7) | NOT NULL |
en
|
||
title |
varchar(500) | NULL | - | |||
description |
text | NULL | - | |||
restrictions |
text | NULL | - | |||
conditions |
text | NULL | - | |||
attribution_text |
text | NULL | - | |||
internal_notes |
text | NULL | - |
donor_agreement_record
6 columns
2 rows
| Column | Type | Nullable | Default | Extra | Comment | |
|---|---|---|---|---|---|---|
| PK | id |
int | NOT NULL | - | auto_increment | |
| FK | agreement_id |
int | NOT NULL | - | ||
| FK | information_object_id |
int | NOT NULL | - | ||
relationship_type |
varchar(44) | NOT NULL |
covers
|
covers, partially_covers, references | ||
notes |
text | NULL | - | |||
created_at |
datetime | NOT NULL |
CURRENT_TIMESTAMP
|
DEFAULT_GENERATED |
donor_agreement_reminder
26 columns
3 rows
| Column | Type | Nullable | Default | Extra | Comment | |
|---|---|---|---|---|---|---|
| PK | id |
int unsigned | NOT NULL | - | auto_increment | |
| FK | donor_agreement_id |
int | NOT NULL | - | ||
reminder_type |
varchar(141) | NOT NULL | - | expiry_warning, review_due, renewal_required, restriction_ending, payment_due, donor_contact, anniversary, audit, preservation_check, custom | ||
subject |
varchar(255) | NOT NULL | - | |||
description |
text | NULL | - | |||
| FK | reminder_date |
date | NOT NULL | - | ||
advance_days |
int | NULL |
30
|
|||
is_recurring |
tinyint(1) | NULL |
0
|
|||
recurrence_pattern |
varchar(47) | NULL | - | daily, weekly, monthly, quarterly, yearly | ||
recurrence_end_date |
date | NULL | - | |||
| FK | priority |
varchar(32) | NULL |
normal
|
low, normal, high, urgent | |
notify_email |
tinyint(1) | NULL |
1
|
|||
notify_system |
tinyint(1) | NULL |
1
|
|||
notification_recipients |
text | NULL | - | |||
| FK | status |
varchar(44) | NULL |
active
|
active, snoozed, completed, cancelled | |
snooze_until |
date | NULL | - | |||
completed_at |
datetime | NULL | - | |||
completed_by |
int unsigned | NULL | - | |||
completion_notes |
text | NULL | - | |||
action_required |
text | NULL | - | |||
action_url |
varchar(500) | NULL | - | |||
created_by |
int unsigned | NULL | - | |||
created_at |
datetime | NULL |
CURRENT_TIMESTAMP
|
DEFAULT_GENERATED | ||
updated_at |
datetime | NULL |
CURRENT_TIMESTAMP
|
DEFAULT_GENERATED on update CURRENT_TIMESTAMP | ||
is_sent |
tinyint(1) | NULL |
0
|
|||
sent_at |
datetime | NULL | - |
donor_agreement_reminder_log
11 columns
0 rows
| Column | Type | Nullable | Default | Extra | Comment | |
|---|---|---|---|---|---|---|
| PK | id |
int unsigned | NOT NULL | - | auto_increment | |
| FK | donor_agreement_reminder_id |
int unsigned | NOT NULL | - | ||
sent_at |
datetime | NOT NULL | - | |||
sent_to |
text | NOT NULL | - | |||
notification_method |
varchar(27) | NOT NULL | - | email, system, both | ||
status |
varchar(29) | NOT NULL | - | sent, failed, bounced | ||
error_message |
text | NULL | - | |||
acknowledged_at |
datetime | NULL | - | |||
acknowledged_by |
int unsigned | NULL | - | |||
response_action |
varchar(255) | NULL | - | |||
created_at |
datetime | NULL |
CURRENT_TIMESTAMP
|
DEFAULT_GENERATED |
donor_agreement_restriction
22 columns
0 rows
| Column | Type | Nullable | Default | Extra | Comment | |
|---|---|---|---|---|---|---|
| PK | id |
int unsigned | NOT NULL | - | auto_increment | |
| FK | donor_agreement_id |
int | NOT NULL | - | ||
| FK | restriction_type |
varchar(221) | NOT NULL | - | closure, partial_closure, redaction, permission_only, researcher_only, onsite_only, no_copying, no_publication, anonymization, time_embargo, review_required, security_clearance, popia_restricted, legal_hold, cultural_protocol | |
applies_to_all |
tinyint(1) | NULL |
1
|
|||
specific_materials |
text | NULL | - | |||
box_list |
text | NULL | - | |||
start_date |
date | NULL | - | |||
end_date |
date | NULL | - | |||
auto_release |
tinyint(1) | NULL |
0
|
|||
| FK | release_date |
date | NULL | - | ||
release_trigger |
varchar(255) | NULL | - | |||
can_be_overridden |
tinyint(1) | NULL |
0
|
|||
override_authority |
varchar(255) | NULL | - | |||
reason |
text | NULL | - | |||
legal_basis |
text | NULL | - | |||
popia_category |
varchar(63) | NULL | - | special_personal, personal, children, criminal, biometric | ||
data_subject_consent |
tinyint(1) | NULL | - | |||
security_clearance_level |
int | NULL | - | |||
notes |
text | NULL | - | |||
created_at |
datetime | NULL |
CURRENT_TIMESTAMP
|
DEFAULT_GENERATED | ||
updated_at |
datetime | NULL |
CURRENT_TIMESTAMP
|
DEFAULT_GENERATED on update CURRENT_TIMESTAMP | ||
is_active |
tinyint(1) | NOT NULL |
1
|
donor_agreement_right
16 columns
0 rows
| Column | Type | Nullable | Default | Extra | Comment | |
|---|---|---|---|---|---|---|
| PK | id |
int unsigned | NOT NULL | - | auto_increment | |
| FK | donor_agreement_id |
int | NOT NULL | - | ||
| FK | right_type |
varchar(147) | NOT NULL | - | replicate, migrate, modify, use, disseminate, delete, display, publish, digitize, reproduce, loan, exhibit, broadcast, commercial_use, derivative_works | |
permission |
varchar(51) | NOT NULL | - | granted, restricted, prohibited, conditional | ||
conditions |
text | NULL | - | |||
applies_to_digital |
tinyint(1) | NULL |
1
|
|||
applies_to_physical |
tinyint(1) | NULL |
1
|
|||
applies_to_metadata |
tinyint(1) | NULL |
1
|
|||
start_date |
date | NULL | - | |||
end_date |
date | NULL | - | |||
requires_donor_approval |
tinyint(1) | NULL |
0
|
|||
requires_fee |
tinyint(1) | NULL |
0
|
|||
fee_structure |
text | NULL | - | |||
notes |
text | NULL | - | |||
created_at |
datetime | NULL |
CURRENT_TIMESTAMP
|
DEFAULT_GENERATED | ||
updated_at |
datetime | NULL |
CURRENT_TIMESTAMP
|
DEFAULT_GENERATED on update CURRENT_TIMESTAMP |
donor_agreement_rights
11 columns
0 rows
| Column | Type | Nullable | Default | Extra | Comment | |
|---|---|---|---|---|---|---|
| PK | id |
int | NOT NULL | - | auto_increment | |
| FK | donor_agreement_id |
int | NOT NULL | - | ||
| FK | extended_rights_id |
bigint unsigned | NULL | - | ||
| FK | embargo_id |
bigint unsigned | NULL | - | ||
applies_to |
varchar(75) | NULL |
all_items
|
all_items, specific_items, digital_only, physical_only, metadata_only | ||
auto_apply |
tinyint(1) | NULL |
1
|
|||
inherit_to_children |
tinyint(1) | NULL |
1
|
|||
notes |
text | NULL | - | |||
created_by |
int | NULL | - | |||
created_at |
timestamp | NULL |
CURRENT_TIMESTAMP
|
DEFAULT_GENERATED | ||
updated_at |
timestamp | NULL |
CURRENT_TIMESTAMP
|
DEFAULT_GENERATED on update CURRENT_TIMESTAMP |
donor_provenance
16 columns
0 rows
| Column | Type | Nullable | Default | Extra | Comment | |
|---|---|---|---|---|---|---|
| PK | id |
int | NOT NULL | - | auto_increment | |
| FK | donor_id |
int | NOT NULL | - | ||
| FK | information_object_id |
int | NOT NULL | - | ||
| FK | donor_agreement_id |
int | NULL | - | ||
agreement_item_id |
int | NULL | - | |||
relationship_type |
varchar(74) | NULL |
donated
|
donated, deposited, loaned, purchased, transferred, bequeathed, gifted | ||
provenance_date |
date | NULL | - | |||
sequence_number |
int | NULL | - | |||
is_current_owner |
tinyint(1) | NULL |
0
|
|||
custody_start_date |
date | NULL | - | |||
custody_end_date |
date | NULL | - | |||
notes |
text | NULL | - | |||
source_of_acquisition |
text | NULL | - | |||
created_by |
int | NULL | - | |||
created_at |
timestamp | NULL |
CURRENT_TIMESTAMP
|
DEFAULT_GENERATED | ||
updated_at |
timestamp | NULL |
CURRENT_TIMESTAMP
|
DEFAULT_GENERATED on update CURRENT_TIMESTAMP |
Notes
Log in to add notes.
Legend
PK Primary Key
FK Foreign Key / Index
UQ Unique Constraint
Table structures are read live from the database. Row counts reflect current data.