Bug #3677

Maintenance notes don't roundtrip to EAC-CPF <maintenanceHistory>

Added by David Juhasz over 11 years ago. Updated about 9 years ago.

Status:VerifiedStart date:
Priority:LowDue date:
Assignee:José Raddaoui Marín% Done:

100%

Category:EAC - Import/Export
Target version:Release 1.4.0
Google Code Legacy ID:atom-1728 Tested version:
Sponsored:No Requires documentation:

Description

To reproduce this error:

1)Import the attached EAC XML file
2)Export to EAC-CPF

Resulting error:

Export contains a <maintenanceEvent /> for the creation and revision date in ICA-AtoM, but none of the original <maintenanceHistory /> data.

Expected result:

<maintenanceHistory /> data should be preserved.

[g] Legacy categories: Import/Export

Lemoyne.XSD.xml Magnifier (5.96 KB) David Juhasz, 12/01/2012 03:43 AM


Related issues

Related to Access to Memory (AtoM) - Bug #4380: EAC - AtoM Control Area data being dropped on Import Verified 07/11/2012
Duplicated by Access to Memory (AtoM) - Bug #3670: On EAC import, maintenance note field filled with extra text Duplicate

History

#1 Updated by David Juhasz over 11 years ago

  • Subject set to Maintenance notes don't roundtrip to EAC-CPF &lt;maintenanceHistory&gt;

Fix spelling.

#2 Updated by David Juhasz over 11 years ago

See /p/qubit-toolkit/issues/detail?id=1727.

#3 Updated by David Juhasz over 11 years ago

Implementing good round-tripping will require the changes in /p/qubit-toolkit/issues/detail?id=1727 to meet the EAC-CPF requirements for the <maintenanceEvent> element.

#4 Updated by David Juhasz over 11 years ago

  • Priority changed from High to Medium
  • Target version changed from Release 1.1 to Release 1.2

Bump to later milestone.

[g] Labels added: Priority-Medium, Milestone-Release-1.2
[g] Labels removed: Priority-High, Milestone-Release-1.1

#6 Updated by David Juhasz almost 11 years ago

  • Priority set to Low

[g] Labels added: Priority-Low

#7 Updated by David Juhasz over 10 years ago

  • Target version set to Release 1.3

Roll over to Release 1.3

[g] Labels added: Milestone-Release-1.3

#8 Updated by David Juhasz almost 10 years ago

Reassign to new account.

[g] New owner: David Juhasz

#9 Updated by Jessica Bushey over 9 years ago

  • Target version changed from Release 1.3 to Release 2.1.0

On export: Maintenance History and Event are present in ICA-AtoM EAC export, but the actual data in the maintenance notes field from ICA-AtoM is dropped. Nowhere in the EAC.

On import: The text added prior to export is missing, but info in this field in AtoM after import includes: automated date, time and “human” is added.

[g] Labels added: Milestone-Release-2.0
[g] Labels removed: Milestone-Release-1.3

#10 Updated by Dan Gillean over 9 years ago

  • Assignee changed from David Juhasz to José Raddaoui Marín
  • Target version changed from Release 2.1.0 to Release 1.4.0

#11 Updated by José Raddaoui Marín over 9 years ago

Dates of creation, revision and deletion. Maintenance notes.

These fields are exported the same way according to ISAAR (CPF) 5.4.6 and 5.4.9

AtoM exports two internal events instead of the actor fields. After, imports all on maintenance notes field.

EXPORT EXAMPLE:

<maintenanceHistory>
  <maintenanceEvent>
    <eventType>created</eventType>
    <eventDateTime standardDateTime="2012-12-03T05:01:53">December 3, 2012 5:01:53 AM PST</eventDateTime>
    <agentType>human</agentType>
    <agent></agent>
  </maintenanceEvent>

  <maintenanceEvent>
    <eventType>revised</eventType>
    <eventDateTime standardDateTime="2013-01-29T08:11:57">January 29, 2013 8:11:57 AM PST</eventDateTime>
    <agentType>human</agentType>
    <agent></agent>
  </maintenanceEvent>
</maintenanceHistory>

About "maintenance notes" I can add it as a <eventDescription> in the revised event. Like this:

<maintenanceEvent>
  <eventType>revised</eventType>
  <eventDateTime standardDateTime="2012-12-03T05:01:53">December 3, 2012 5:01:53 AM PST</eventDateTime>
  <agentyType>human</agentyType>
  <agent></agent>
  <eventDescription>[maintenance notes]</eventDescription>
</maintenanceEvent>

But, how should I export "dates of creation, revision and deletion" string value in <maintenanceEvent>? Without knowing the nature of the string dates or the <eventType> values.

#12 Updated by Dan Gillean over 9 years ago

  • Sponsored set to No

Hi Radda,
EAC is unfortunately not very well mapped to ISAAR, though that was supposed to be its intent.

My suggestions are as such:

Dates of Creation, revision and Deletion
EAC – ISAAR Crosswalk recommends this:

<maintenanceEvent><eventDateTime>

There is no reason we have to add the standardDateTime attribute in this case because the AtoM field is free-text. Looking at the description of the element, <eventDateTime> can contain [text]. We might also add an xml:id attribute to separate the two – id=“ISAAR5.4.6” or id=”DatesCreationRevision” (or even just “546” if need be) or something similar. If it is easier to manage, the <maintenanceEvent> element can also support the id attribute – I suggest using one of these to distinguish the kinds of event notes for each field. That should allow us to parse which kind of maintenancEvent maps to which AtoM / ISAAR field.

If putting free-text from user generated data doesn’t work, we can still use <eventDescription> to contain the user data for each field.
The other thing we could do is add agent information to distinguish the two, where (if possible) we pull the agent information from the user login information in AtoM (similar to how the “other notes” field is managed in the RAD Notes Area). It might look like this

Dates of creation, revision, and deletion:

<maintenanceEvent id=”5.4.6”>
    <eventDescription> user entered dates of creation, revision, and deletion notes are displayed here </eventDescription>
<eventDateTime standardDateTime="2013-01-29T08:11:57">January 29, 2013 8:11:57 AM PST</eventDateTime>
  </maintenanceEvent>
</maintenanceHistory>

I don’t see anything that says that a <maintenanceEvent> has to include an eventType, so for this field, we could always leave it out? Or – the system should generate an automatic addition to this field when the description is created, and all others should be assumed to be “revised” or “updated” if we do want to include this information. The most important thing for roundtripping is the user data, not the system-generated data.

For the Maintenance notes, we are also losing user entered data when we export, as it is being replaced by the system-generated data. Again, I would suggest capturing this user data in the <eventDescription>, and using an id to distinguish between system generated notes, which can be set to “computer.”

  <maintenanceEvent id=”5.4.9”>
    <eventDescription> user entered maintenance notes are displayed here </eventDescription>
<eventType>revised</eventType>
    <eventDateTime id=”ISAAR5.4.9” standardDateTime="2013-01-29T08:11:57">January 29, 2013 8:11:57 AM PST</eventDateTime>
    <agentType>human:</agentType>
    <agent> John Smith </agent>
 </maintenanceEvent>
</maintenanceHistory>

So the import/export data might look like:

Description was updated by the Imaginary Archives Staff on January 29th . (January 29, 2013 8:11:57 AM PST human: John Smith)

Note that if we are appending a user name, it would be nice (if possible) not to display “human” – I don’t know if this can be scripted to be present in the XML without displaying in the field, but that would be cool. If not the above would be fine.

Let me know if this helps.

#13 Updated by Dan Gillean over 9 years ago

  • Description updated (diff)

#14 Updated by Jesús García Crespo about 9 years ago

  • Status changed from New to QA/Review
  • % Done changed from 0 to 100

Applied in changeset atom|commit:6adde8e02bf279f35178adc5b0ee2da24d37f9a7.

#15 Updated by Jessica Bushey about 9 years ago

  • Category set to EAC - Import/Export
  • Status changed from QA/Review to Feedback

Maintenance notes are successfully roundtripping in EAC.
No strange date or "human" added to maintenance notes.
Dates of creation, revision and deletion are successfully roundtripping

#16 Updated by José Raddaoui Marín about 9 years ago

  • Status changed from Feedback to QA/Review

Did you want to put verified?

#17 Updated by Jesús García Crespo about 9 years ago

  • Status changed from QA/Review to Verified

Jessica verified it.

Also available in: Atom PDF