Description
Set includeInSearch only when consented and not withdrawn, returning suppliedKey when included and an empty string otherwise.
Cultural and community records can carry access, attribution, quotation, and publication permissions. Preserving a supplied label does not create permission or override community protocols, source conditions, or an individual's stated preferences.
Set includeInSearch only when consented and not withdrawn, returning suppliedKey when included and an empty string otherwise.
When to use this tool
Use Consented Name Search Key Flag when you need to record a supplied attribution or access statement without expanding its scope.
How to use the tool and how it works
- Enter name, consented, withdrawn, suppliedKey. Use the units and conventions below.
- Run the tool. Correct any format, range, or cross-field input error before interpreting the output.
- Read includeInSearch, searchKey. Inspect includeInSearch before interpreting the associated values.
Require nonempty name. Set includeInSearch only when consented and not withdrawn, returning suppliedKey when included and an empty string otherwise.1
| Input field | Meaning and units | Accepted input |
|---|---|---|
| name | Name | Required. Text; maximum UTF-16 length 8192. |
| consented | Consented | Required. Boolean. |
| withdrawn | Withdrawn | Required. Boolean. |
| suppliedKey | Supplied Key | Required. Text; maximum UTF-16 length 8192. |
| Output field | Interpretation | Returned shape |
|---|---|---|
| includeInSearch | Include In Search | Required. Boolean. |
| searchKey | Supplied key when included, otherwise an empty-string withholding placeholder. | Required. Text; maximum UTF-16 length 8192. |
{
"input": {
"name": "Name A",
"consented": true,
"withdrawn": false,
"suppliedKey": "key-A"
},
"output": {
"includeInSearch": true,
"searchKey": "key-A"
}
}Limitations and assumptions
- No name normalization or search-key generation occurs; flags are supplied records rather than proof of informed consent or authorization to index a person.
- Inputs must satisfy both the field types and the cross-field conditions above. Invalid input causes an error; a successful false flag or documented placeholder is a different result.
Alternative or Complementary methods
Confirm the original permission, community protocol, and intended use with the responsible people before sharing material.
References
Similar or alternative tools
- Authorized Item Access Scope
Check requestedPurpose against allowedPurposes.
- Authorized Grapheme Case Variant Token
Look up grapheme literally, returning its paired form and found true, or the unchanged grapheme with found false.