campmlc
commented
1 year ago This is intriguing. . . Could make a mess, but it could be very helpful to see what data needs are out there and for migrating data to prevent data loss pending code table discussion and approval.
On Thu, Aug 10, 2023, 3:53 PM Teresa Mayfield-Meyer < @.***> wrote:
- [EXTERNAL]*
Goal
Describe what you're trying to accomplish. This is the only necessary step to start this process. The Committee is available to assist with all other steps. Please clearly indicate any uncertainty or desired guidance if you proceed beyond this step.
Get data into Arctos without waiting on Code Table agreement Context
Describe why this new value is necessary and existing values are not.
Exploring ways to enter partially structured information when an attribute does not yet exist. For example #6115 https://github.com/ArctosDB/arctos/issues/6115 which was opened 4 months ago, but has not been resolved, leaving a collection unable to enter data. Table
Code Tables are http://arctos.database.museum/info/ctDocumentation.cfm http://arctos.database.museum/info/ctDocumentation.cfm. Link to the specific table or value. This may involve multiple tables and will control datatype for Attributes. OtherID requests require BaseURL (and example) or explanation. Please ask for assistance if unsure.
https://arctos.database.museum/info/ctDocumentation.cfm?table=ctattribute_type Proposed Value
Proposed new value. This should be clear and compatible with similar values in the relevant table and across Arctos.
verbatim attribute Proposed Definition
Clear, complete, non-collection-type-specific functional definition of the value. Avoid discipline-specific terminology if possible, include parenthetically if unavoidable.
The values entered in this attribute should represent structured data about a catalog record that does not fit into an existing attribute. Over time, use of structured terms may result in creation of a new attribute if the community deems it valuable. If units are required, they should be part of the free-text structure (OR should we have a "verbatim free-text" and a "verbatim number+units" option?). Collection type
Some code tables contain collection-type-specific values. collection_cde may be found from https://arctos.database.museum/home.cfm https://arctos.database.museum/home.cfm
All Attribute Extras Attribute data type
If the request is for an attribute, what values will be allowed? free-text, categorical, or number+units depending upon the attribute (TBA)
free-text Attribute controlled values
If the values are categorical (to be controlled by a code table), add a link to the appropriate code table. If a new table or set of values is needed, please elaborate.
N/A Attribute units
if numerical values should be accompanied by units, provide a link to the appropriate units table.
N/A Priority
Please describe the urgency and/or choose a priority-label to the right. You should expect a response within two working days, and may utilize Arctos Contacts https://arctosdb.org/contacts/ if you feel response is lacking.
High! Code table discussion can take a long time (it should) but we need to get data into Arctos within a reasonable time frame. This would offer users the ability to create their own attributes as they go and then we can use the values in this attribute to make decisions about code table requests or event to propose code table values based upon usage here.
BONUS - be able to see the list of values here when entering data so that you can pick from previously entered terms if possible.
DOUBLE BONUS - be able to start typing in the attribute value in search and see the terms that are in use. Example Data
Requests with clarifying sample data are generally much easier to understand and prioritize. Please attach or link to any representative data, in any form or format, which might help clarify the request. Available for Public View
Most data are by default publicly available. Describe any necessary access restrictions.
yes Helpful Actions
-
Add the issue to the Code Table Management Project https://github.com/ArctosDB/arctos/projects/13#card-31628184.
Please reach out to anyone who might be affected by this change. Leave a comment or add this to the Committee agenda if you believe more focused conversation is necessary.
@ArctosDB/arctos-code-table-administrators https://github.com/orgs/ArctosDB/teams/arctos-code-table-administrators Approval
All of the following must be checked before this may proceed.
The How-To Document https://handbook.arctosdb.org/how_to/How-To-Manage-Code-Table-Requests.html should be followed. Pay particular attention to terminology (with emphasis on consistency) and documentation (with emphasis on functionality). No person should act in multiple roles; the submitter cannot also serve as a Code Table Administrator, for example.
- Code Table Administrator[1] - check and initial, comment, or thumbs-up to indicate that the request complies with the how-to documentation and has your approval
- Code Table Administrator[2] - check and initial, comment, or thumbs-up to indicate that the request complies with the how-to documentation and has your approval
- DBA - The request is functionally acceptable. The term is not a functional duplicate, and is compatible with existing data and code.
- DBA - Appropriate code or handlers are in place as necessary. (ID_References, Media Relationships, Encumbrances, etc. require particular attention)
Rejection
If you believe this request should not proceed, explain why here. Suggest any changes that would make the change acceptable, alternate (usually existing) paths to the same goals, etc.
- Can a suitable solution be found here? If not, proceed to (2)
- Can a suitable solution be found by Code Table Committee discussion? If not, proceed to (3)
- Take the discussion to a monthly Arctos Working Group meeting for final resolution.
Implementation
Once all of the Approval Checklist is appropriately checked and there are no Rejection comments, or in special circumstances by decree of the Arctos Working Group, the change may be made.
-
Review everything one last time. Ensure the How-To has been followed. Ensure all checks have been made by appropriate personnel.
Add or revise the code table term/definition as described above. Ensure the URL of this Issue is included in the definition.
Close this Issue.
DO NOT modify Arctos Authorities in any way before all points in this Issue have been fully addressed; data loss may result. Special Exemptions
In very specific cases and by prior approval of The Committee, the approval process may be skipped, and implementation requirements may be slightly altered. Please note here if you are proceeding under one of these use cases.
- Adding an existing term to additional collection types may proceed immediately and without discussion, but doing so may also subject users to future cleanup efforts. If time allows, please review the term and definition as part of this step.
- The Committee may grant special access on particular tables to particular users. This should be exercised with great caution only after several smooth test cases, and generally limited to "taxonomy-like" data such as International Commission on Stratigraphy terminology.
— Reply to this email directly, view it on GitHub https://github.com/ArctosDB/arctos/issues/6622, or unsubscribe https://github.com/notifications/unsubscribe-auth/ADQ7JBCOF3DLKFFYK7CWLD3XUVJ4HANCNFSM6AAAAAA3MDERV4 . You are receiving this because you are on a team that was mentioned.Message ID: @.***>
mkoo
ebraker
dustymc
Jegelewicz
Goal
Describe what you're trying to accomplish. This is the only necessary step to start this process. The Committee is available to assist with all other steps. Please clearly indicate any uncertainty or desired guidance if you proceed beyond this step.
Get data into Arctos without waiting on Code Table agreement
Context
Describe why this new value is necessary and existing values are not.
Exploring ways to enter partially structured information when an attribute does not yet exist. For example https://github.com/ArctosDB/arctos/issues/6115 which was opened 4 months ago, but has not been resolved, leaving a collection unable to enter data.
Table
Code Tables are http://arctos.database.museum/info/ctDocumentation.cfm. Link to the specific table or value. This may involve multiple tables and will control datatype for Attributes. OtherID requests require BaseURL (and example) or explanation. Please ask for assistance if unsure.
https://arctos.database.museum/info/ctDocumentation.cfm?table=ctattribute_type
Proposed Value
Proposed new value. This should be clear and compatible with similar values in the relevant table and across Arctos.
verbatim attribute
Proposed Definition
Clear, complete, non-collection-type-specific functional definition of the value. Avoid discipline-specific terminology if possible, include parenthetically if unavoidable.
The values entered in this attribute should represent structured data about a catalog record that does not fit into an existing attribute. Over time, use of structured terms may result in creation of a new attribute if the community deems it valuable. If units are required, they should be part of the free-text structure. https://github.com/ArctosDB/arctos/issues/6622
(OR should we have a "verbatim free-text" and a "verbatim number+units" option?).Collection type
_Some code tables contain collection-type-specific values.
collection_cdemay be found from https://arctos.database.museum/home.cfm_All
Attribute Extras
Attribute data type
If the request is for an attribute, what values will be allowed? free-text, categorical, or number+units depending upon the attribute (TBA)
free-text
Attribute controlled values
If the values are categorical (to be controlled by a code table), add a link to the appropriate code table. If a new table or set of values is needed, please elaborate.
N/A
Attribute units
if numerical values should be accompanied by units, provide a link to the appropriate units table.
N/A
Priority
Please describe the urgency and/or choose a priority-label to the right. You should expect a response within two working days, and may utilize Arctos Contacts if you feel response is lacking.
High! Code table discussion can take a long time (it should) but we need to get data into Arctos within a reasonable time frame. This would offer users the ability to create their own attributes as they go and then we can use the values in this attribute to make decisions about code table requests or event to propose code table values based upon usage here.
BONUS - be able to see the list of values here when entering data so that you can pick from previously entered terms if possible.
DOUBLE BONUS - be able to start typing in the attribute value in search and see the terms that are in use.
Example Data
Requests with clarifying sample data are generally much easier to understand and prioritize. Please attach or link to any representative data, in any form or format, which might help clarify the request.
Available for Public View
Most data are by default publicly available. Describe any necessary access restrictions.
yes
Helpful Actions
[x] Add the issue to the Code Table Management Project.
[ ] Please reach out to anyone who might be affected by this change. Leave a comment or add this to the Committee agenda if you believe more focused conversation is necessary.
@ArctosDB/arctos-code-table-administrators
Approval
All of the following must be checked before this may proceed.
_The How-To Document should be followed. Pay particular attention to terminology (with emphasis on consistency) and documentation (with emphasis on functionality). No person should act in multiple roles; the submitter cannot also serve as a Code Table Administrator, for example._
Rejection
If you believe this request should not proceed, explain why here. Suggest any changes that would make the change acceptable, alternate (usually existing) paths to the same goals, etc.
Implementation
Once all of the Approval Checklist is appropriately checked and there are no Rejection comments, or in special circumstances by decree of the Arctos Working Group, the change may be made.
[x] Review everything one last time. Ensure the How-To has been followed. Ensure all checks have been made by appropriate personnel.
[x] Add or revise the code table term/definition as described above. Ensure the URL of this Issue is included in the definition.
Close this Issue.
DO NOT modify Arctos Authorities in any way before all points in this Issue have been fully addressed; data loss may result.
Special Exemptions
In very specific cases and by prior approval of The Committee, the approval process may be skipped, and implementation requirements may be slightly altered. Please note here if you are proceeding under one of these use cases.