Catalogue Record Completeness Field Counter
Audit caller-required catalogue fields across aligned records, distinguishing complete records from pooled field coverage; actual schema/presence criteria are caller established.
Description
A catalogue record may contain some required fields without being fully complete.
A catalogue record may contain some required fields without being fully complete. Presence flags depend on the chosen schema and evidence rules.
Audit caller-required catalogue fields across aligned records, distinguishing complete records from pooled field coverage; actual schema/presence criteria are caller established.
When to use Catalogue Record Completeness Field Counter
Use this tool to audit caller-required catalogue fields across aligned records, distinguishing complete records from pooled field coverage; actual schema/presence criteria are caller established.
Prepare the collection, exposure, scheduling or financial records required for this calculation. Keep row order and the declared units consistent.
How to use Catalogue Record Completeness Field Counter and understand its results
- Prepare the collection, exposure, scheduling or financial records required for this calculation. Keep row order and the declared units consistent.
- Enter recordFieldPresenceMatrix, callerRequiredFieldFlags using the field table and calculation rules, then run the tool.
- Read requiredFieldCountsPerRecord, requiredCompletenessPercentPerRecord, fullyCompleteRecordCount. The explanation below defines the units, signs, ordering and any flags or placeholder values.
- If the tool reports an input issue, correct the values and run it again. Apply the stated assumptions when interpreting a successfully returned result.
| Input field | Meaning | Value type; see rules below | Requirement |
|---|---|---|---|
| recordFieldPresenceMatrix | Record field presence matrix | list of list of number | Required |
| callerRequiredFieldFlags | Caller required field flags | list of number | Required |
Use a nonempty rectangular binary presence matrix up to 128×128 with aligned binary requirement columns. Require at least one required field. Return local required counts, percentages and fully complete records.1
record completeness = 100 × present required fields/required field count Units, indexing, boundary conditions and exceptional cases are defined in the calculation rules above.
| Output field | Meaning | Value type |
|---|---|---|
| requiredFieldCountsPerRecord | Required field counts per record | list of number |
| requiredCompletenessPercentPerRecord | Required completeness percent per record | list of number |
| fullyCompleteRecordCount | Fully complete record count | number |
{
"input": {
"recordFieldPresenceMatrix": [
[
1,
0,
1
],
[
1,
1,
1
]
],
"callerRequiredFieldFlags": [
1,
1,
0
]
},
"output": {
"requiredFieldCountsPerRecord": [
1,
2
],
"requiredCompletenessPercentPerRecord": [
50,
100
],
"fullyCompleteRecordCount": 1
}
}Limitations and assumptions
Presence is caller-established and does not establish metadata accuracy.
Numbers and computed results must be finite; overflow produces an error. Matrices are limited to 128 rows and 128 entries per row; other numeric lists are limited to 100,000 entries. Missing required fields, extra fields, wrong value types and violations of the calculation rules are input errors.
Alternative or Complementary methods
Use Digitisation Batch Throughput Items per Day Calculator: Track QC-accepted digitization throughput separately from capture count across actual productive-day exposure; no implied metadata completion or full preservation workflow completion. For a complementary task, use Duplicate Accession Conflict Detector: Detect exact strict accession identity conflicts across source rows without silently normalizing malformed identifiers; no conflict resolution or ownership decision.
References
Similar or alternative tools
- Digitisation Batch Throughput Items per Day Calculator
Track QC-accepted digitization throughput separately from capture count across actual productive-day exposure; no implied metadata completion or full preservation workflow completion.
- Duplicate Accession Conflict Detector
Detect exact strict accession identity conflicts across source rows without silently normalizing malformed identifiers; no conflict resolution or ownership decision.