From: Aron Roberts <aron@socrates.berkeley.edu>
Date: Thu, 14 Oct 2010 23:22:02 +0000 (+0000)
Subject: CSPACE-3053: Updated read me file with a first pass at designating 'largetext' fields... 
X-Git-Url: https://git.aero2k.de/?a=commitdiff_plain;h=74f34e7c7722e16970324055af62a6ec3822d5af;p=tmp%2Fjakarta-migration.git

CSPACE-3053: Updated read me file with a first pass at designating 'largetext' fields in object and procedural records - those which require storage of > 500 characters, which is Nuxeo's per-field default for MySQL.  The contents of this file must currently be pasted into an active Nuxeo default-repository-config.xml configuration file, such as in /usr/local/share/jboss/templates/collectionspace_mysql/config, and per a follow-on JIRA, might instead be integrated int the services deployment process.
---

diff --git a/services/collectionobject/3rdparty/nuxeo-platform-cs-collectionobject/src/main/resources/README.txt b/services/collectionobject/3rdparty/nuxeo-platform-cs-collectionobject/src/main/resources/README.txt
index c1768552b..742ea0b1c 100644
--- a/services/collectionobject/3rdparty/nuxeo-platform-cs-collectionobject/src/main/resources/README.txt
+++ b/services/collectionobject/3rdparty/nuxeo-platform-cs-collectionobject/src/main/resources/README.txt
@@ -1,78 +1,224 @@
-Copy the following Nuxeo field type declarations to the ..\nuxeo.ear\config\default-repository-config.xml file.  Insert into the existing <schema> element.
+Copy the following Nuxeo field type declarations to
+$JBOSS_HOME/templates/collectionspace_mysql/config/default-repository-config.xml
+Insert into the existing <schema> element.
+
+          <!-- Text fields that may possibly not require largetext -->
+          <!-- designation and might need further review are marked as follows: -->
+          <!-- * -->
+
+          <!-- =========================================================== -->
+          <!-- Acquisition fields -->
+          <!-- =========================================================== -->
+
+          <field type="largetext">acquisitions_common:acquisitionNote</field>
+          <field type="largetext">acquisitions_common:acquisitionProvisos</field>
+          <field type="largetext">acquisitions_common:acquisitionReason</field>
+
+          <!-- Add in 1.1 per CSPACE-2769 -->
+          <!-- field type="largetext">acquisitions_common:creditLine</field -->
+
+
+          <!-- =========================================================== -->
+          <!-- CollectionObject / Cataloging fields -->
+          <!-- =========================================================== -->
+
+          <!-- Object Identification Information -->
+          <!-- ================================= -->
+
+          <!-- FIXME: Will become group repeatable in 1.1 -->
+          <field type="largetext">collectionobjects_common:otherNumber</field> <!-- * -->
+          <!-- End of group repeatable -->
+
+          <!-- FIXME: multivalued field - need to verify schema and field name -->
+          <field type="largetext">collectionobjects_common:briefDescriptions</field>
+
+          <!-- FIXME: multivalued field - need to verify schema and field name -->
+          <field type="largetext">collectionobjects_common:comments</field>
+
+          <field type="largetext">collectionobjects_common:distinguishingFeatures</field>
+
+          <!-- FIXME: group repeatable - need to verify schema and field name -->
+          <field type="largetext">collectionobjects_common:objectNameNote</field>
+
+          <!-- FIXME: Will become group repeatable in 1.1 -->
+          <field type="largetext">collectionobjects_common:title</field>
+          <field type="largetext">collectionobjects_common:titleTranslation</field>
+
+          <!-- Object Description Information -->
+          <!-- ============================== -->
+
+          <!-- FIXME: Need to check each field from this point and below -->
+          <!-- to anticipate group repeatability changes coming in 1.1, -->
+          <!-- as we may need to change schema and field names when that occurs. -->
+
+          <field type="largetext">collectionobjects_common:ageQualifier</field>
+          <field type="largetext">collectionobjects_common:color</field>
+          <field type="largetext">collectionobjects_common:contentDescription</field>
+          <field type="largetext">collectionobjects_common:contentNote</field>
+          <field type="largetext">collectionobjects_common:contentObject</field>
+          <field type="largetext">collectionobjects_common:copyNumber</field> <!-- * -->
+          <field type="largetext">collectionobjects_common:editionNumber</field> <!-- * -->
+
+           <!-- FIXME: Will become group repeatable in 1.1 -->
+          <field type="largetext">collectionobjects_common:inscriptionContent</field>
+          <field type="largetext">collectionobjects_common:inscriptionContentInterpretation</field>
+          <field type="largetext">collectionobjects_common:inscriptionContentTranslation</field>
+          <field type="largetext">collectionobjects_common:inscriptionContentTransliteration</field>
+
+          <!-- FIXME: Will become group repeatable in 1.1 -->
+          <field type="largetext">collectionobjects_common:inscriptionDescriptionInterpretation</field>
+
+          <!-- FIXME: Will become group repeatable in 1.1 -->
+          <field type="largetext">collectionobjects_common:materialComponentNote</field>
+          <field type="largetext">collectionobjects_common:materialName</field>  <!-- * -->
+
+          <!-- FIXME: multivalued field - need to verify schema and field name -->
+          <field type="largetext">collectionobjects_common:physicalDescription</field>
+
+          <!-- FIXME: Will become part of a group repeatable in 1.1 -->
+          <field type="largetext">collectionobjects_common:objectComponentInformation</field>
+
+          <!-- Object Production Information -->
+          <!-- ============================= -->
+
+          <field type="largetext">collectionobjects_common:objectProductionNote</field>
+
+          <!-- FIXME: multivalued field - need to verify schema and field name -->
+          <field type="largetext">collectionobjects_common:objectProductionReason</field>
+
+          <!-- Object History and Association Information -->
+          <!-- ========================================== -->
+
+          <!-- FIXME: Will become part of a group repeatable in 1.1 -->
+          <field type="largetext">collectionobjects_common:assocActivityNote</field>
+
+          <field type="largetext">collectionobjects_common:assocConceptNote</field>
+          <field type="largetext">collectionobjects_common:assocCulturalContextNote</field>
+          <field type="largetext">collectionobjects_common:assocDateNote</field>
+          <field type="largetext">collectionobjects_common:assocEventNote</field>
+          <field type="largetext">collectionobjects_common:assocObject</field>
+          <field type="largetext">collectionobjects_common:assocOrganizationNote</field>
+          <field type="largetext">collectionobjects_common:assocPeopleNote</field>
+          <field type="largetext">collectionobjects_common:assocPersonNote</field>
+          <field type="largetext">collectionobjects_common:assocPlaceNote</field>
+
+          <field type="largetext">collectionobjects_common:objectHistoryNote</field>
+          <field type="largetext">collectionobjects_common:ownershipExchangeNote</field>
+          <field type="largetext">collectionobjects_common:usageNote</field>
+
+           <!-- Object Owner's Contribution Information -->
+           <!-- ======================================= -->
+
+          <field type="largetext">collectionobjects_common:ownersPersonalExperience</field>
+          <field type="largetext">collectionobjects_common:ownersPersonalResponse</field>
+
+          <!-- FIXME: multivalued field - need to verify schema and field name -->
+          <field type="largetext">collectionobjects_common:ownersReference</field>
+
+          <field type="largetext">collectionobjects_common:ownersContributionNote</field>
+
+          <!-- Object Viewer's Contribution Information -->
+          <!-- ======================================== -->
+
+          <field type="largetext">collectionobjects_common:viewersRole</field>
+          <field type="largetext">collectionobjects_common:viewersPersonalExperience</field>
+          <field type="largetext">collectionobjects_common:viewersPersonalResponse</field>
+
+          <!-- FIXME: multivalued field - need to verify schema and field name -->
+          <field type="largetext">collectionobjects_common:viewersReference</field>
+
+          <field type="largetext">collectionobjects_common:viewersContributionNote</field>
+
+          <!-- Reference Information -->
+          <!-- ===================== -->
+
+          <field type="largetext">collectionobjects_common:catalogNumber</field> <!-- * -->
+
+          <!-- Object Collection Information -->
+          <!-- ============================= -->
+
+          <field type="largetext">collectionobjects_common:fieldCollectionNote</field>
+          <field type="largetext">collectionobjects_common:fieldCollectionNumber</field> <!-- * -->
+
+          <!--
+              Additional non-text fields configured as 'largetext' to
+              avoid the following error when Nuxeo is configured to use MySQL:
+
+              com.mysql.jdbc.exceptions.jdbc4.MySQLSyntaxErrorException.
+              message: Row size too large. The maximum row size for the
+              used table type, not counting BLOBs, is 65535.
+
+              Some of the fields below may be repeatable or in
+              repeatable groups, and the schema and field names
+              below might thus require verification to match actual values.
+          -->
 
-          <!-- CollectionObject fields -->
           <field type="largetext">collectionobjects_common:objectNumber</field>
           <field type="largetext">collectionobjects_common:otherNumber</field>
           <field type="largetext">collectionobjects_common:otherNumberType</field>
-          <field type="largetext">collectionobjects_common:briefDescriptions</field>
-          <field type="largetext">collectionobjects_common:distinguishingFeatures</field>
           <field type="largetext">collectionobjects_common:numberOfObjects</field>
-          
-          
           <field type="largetext">collectionobjects_common:collection</field>
-          <field type="largetext">collectionobjects_common:title</field>
-          <field type="largetext">collectionobjects_common:titleLanguage</field>
-          <field type="largetext">collectionobjects_common:titleTranslation</field>
           <field type="largetext">collectionobjects_common:titleTranslationLanguage</field>
           <field type="largetext">collectionobjects_common:titleType</field>
           <field type="largetext">collectionobjects_common:recordStatus</field>
           <field type="largetext">collectionobjects_common:age</field>
           <field type="largetext">collectionobjects_common:ageQualifier</field>
           <field type="largetext">collectionobjects_common:ageUnit</field>
-                    
+
           <field type="largetext">collectionobjects_common:contentDate</field>
-          <field type="largetext">collectionobjects_common:contentDescription</field>
           <field type="largetext">collectionobjects_common:contentEventName</field>
           <field type="largetext">collectionobjects_common:contentEventNameType</field>
-          <field type="largetext">collectionobjects_common:contentNote</field>
           <field type="largetext">collectionobjects_common:contentLanguages</field>
-          <field type="largetext">collectionobjects_common:contentObject</field>
           <field type="largetext">collectionobjects_common:contentObjectType</field>
           <field type="largetext">collectionobjects_common:contentOrganizations</field>
           <field type="largetext">collectionobjects_common:contentOther</field>
           <field type="largetext">collectionobjects_common:contentOtherType</field>
-          <field type="largetext">collectionobjects_common:copyNumber</field>
-          
+
           <field type="largetext">collectionobjects_common:dimensionSummary</field>
+
+          <!-- These fields may be removed altogether when App/UI is using repeatable dimensions group -->
           <field type="largetext">collectionobjects_common:dimension</field>
           <field type="largetext">collectionobjects_common:dimensionMeasuredPart</field>
           <field type="largetext">collectionobjects_common:dimensionMeasurementUnit</field>
           <field type="largetext">collectionobjects_common:dimensionValue</field>
           <field type="largetext">collectionobjects_common:dimensionValueDate</field>
           <field type="largetext">collectionobjects_common:dimensionValueQualifier</field>
+
           <field type="largetext">collectionobjects_common:editionNumber</field>
-          
-          <field type="largetext">collectionobjects_common:inscriptionContent</field>
+
           <field type="largetext">collectionobjects_common:inscriptionContentInscriber</field>
           <field type="largetext">collectionobjects_common:inscriptionContentDate</field>
-          <field type="largetext">collectionobjects_common:inscriptionContentInterpretation</field>
           <field type="largetext">collectionobjects_common:inscriptionContentLanguage</field>
           <field type="largetext">collectionobjects_common:inscriptionContentMethod</field>
           <field type="largetext">collectionobjects_common:inscriptionContentPosition</field>
           <field type="largetext">collectionobjects_common:inscriptionContentScript</field>
-          <field type="largetext">collectionobjects_common:inscriptionContentTranslation</field>
-          <field type="largetext">collectionobjects_common:inscriptionContentTransliteration</field>
           <field type="largetext">collectionobjects_common:inscriptionContentType</field>
+
           <field type="largetext">collectionobjects_common:inscriptionDescription</field>
           <field type="largetext">collectionobjects_common:inscriptionDescriptionInscriber</field>
           <field type="largetext">collectionobjects_common:inscriptionDescriptionDate</field>
-          <field type="largetext">collectionobjects_common:inscriptionDescriptionInterpretation</field>
           <field type="largetext">collectionobjects_common:inscriptionDescriptionMethod</field>
           <field type="largetext">collectionobjects_common:inscriptionDescriptionPosition</field>
           <field type="largetext">collectionobjects_common:inscriptionDescriptionType</field>
-          
-          <field type="largetext">collectionobjects_common:ownersReferences</field>
-          <field type="largetext">collectionobjects_common:ownersContributionNote</field>
-          <field type="largetext">collectionobjects_common:viewersRole</field>
-          <field type="largetext">collectionobjects_common:viewersPersonalExperience</field>
-          <field type="largetext">collectionobjects_common:viewersPersonalResponse</field>
-          <field type="largetext">collectionobjects_common:viewersContributionNote</field>
-          <field type="largetext">collectionobjects_common:catalogNumber</field>
-          <field type="largetext">collectionobjects_common:fieldCollectionDate</field>
-          <field type="largetext">collectionobjects_common:fieldCollectionMethods</field>
-          <field type="largetext">collectionobjects_common:fieldCollectionNote</field>
+
+          <field type="largetext">collectionobjects_common:objectStatus</field>
+          <field type="largetext">collectionobjects_common:phase</field>
+          <field type="largetext">collectionobjects_common:sex</field>
+          <field type="largetext">collectionobjects_common:assocObjectType</field>
+          <field type="largetext">collectionobjects_common:ownershipAccess</field>
+          <field type="largetext">collectionobjects_common:ownershipCategory</field>
+          <field type="largetext">collectionobjects_common:ownershipDates</field>
+          <field type="largetext">collectionobjects_common:ownershipExchangeMethod</field>
+          <field type="largetext">collectionobjects_common:ownershipExchangePriceCurrency</field>
+          <field type="largetext">collectionobjects_common:ownershipExchangePriceValue</field>
+          <field type="largetext">collectionobjects_common:ownershipPlace</field>
+          <field type="largetext">collectionobjects_common:usage</field>
           <field type="largetext">collectionobjects_common:fieldCollectionNumber</field>
+          <field type="largetext">collectionobjects_common:fieldCollectionMethod</field>
           <field type="largetext">collectionobjects_common:fieldCollectionPlace</field>
+
+          <!-- This sample set of date field can be removed when Cataloging -->
+          <!-- records are using structured date fields -->
           <field type="largetext">collectionobjects_common:dateAssociation</field>
           <field type="largetext">collectionobjects_common:dateEarliestSingle</field>
           <field type="largetext">collectionobjects_common:dateEarliestSingleCertainty</field>
@@ -82,24 +228,86 @@ Copy the following Nuxeo field type declarations to the ..\nuxeo.ear\config\defa
           <field type="largetext">collectionobjects_common:dateLatestQualifier</field>
           <field type="largetext">collectionobjects_common:datePeriod</field>
           <field type="largetext">collectionobjects_common:dateText</field>
-          <field type="largetext">collectionobjects_common:ownersPersonalExperience</field>
-          <field type="largetext">collectionobjects_common:ownersPersonalResponse</field>
-          <field type="largetext">collectionobjects_common:ownersReferences</field>
-          <field type="largetext">collectionobjects_common:ownersContributionNote</field>
-          <field type="largetext">collectionobjects_common:viewersRole</field>
-          <field type="largetext">collectionobjects_common:viewersPersonalExperience</field>
-          <field type="largetext">collectionobjects_common:viewersPersonalResponse</field>
-          <field type="largetext">collectionobjects_common:viewersReferences</field>
-          <field type="largetext">collectionobjects_common:viewersContributionNote</field>
-          <field type="largetext">collectionobjects_common:references</field>
-          <field type="largetext">collectionobjects_common:owners</field>
-          <field type="largetext">collectionobjects_common:ownershipAccess</field>
-          <field type="largetext">collectionobjects_common:ownershipCategory</field>
-          <field type="largetext">collectionobjects_common:ownershipDates</field>
-          <field type="largetext">collectionobjects_common:ownershipExchangeMethod</field>
-          <field type="largetext">collectionobjects_common:ownershipExchangeNote</field>
-          <field type="largetext">collectionobjects_common:ownershipExchangePriceCurrency</field>
-          <field type="largetext">collectionobjects_common:ownershipExchangePriceValue</field>
-          <field type="largetext">collectionobjects_common:ownershipPlace</field>
-          <field type="largetext">collectionobjects_common:usage</field>
-          <field type="largetext">collectionobjects_common:usageNote</field>
+
+
+          <!-- =========================================================== -->
+          <!-- Contact fields -->
+          <!-- =========================================================== -->
+          <field type="largetext">contacts_common:addressPlace</field>
+
+
+          <!-- =========================================================== -->
+          <!-- Intake fields -->
+          <!-- =========================================================== -->
+
+          <field type="largetext">intakes_common:entryNote</field>
+          <field type="largetext">intakes_common:packingNote</field>
+          <field type="largetext">intakes_common:fieldCollectionNote</field>
+          <field type="largetext">intakes_common:insuranceNote</field>
+          <field type="largetext">intakes_common:currentLocationNote</field>
+          <field type="largetext">intakes_common:conditionCheckNote</field>
+
+          <!-- FIXME: multivalued field - need to verify schema and field name -->
+          <field type="largetext">intakes_common:conditionCheckReasons</field>
+
+
+          <!-- =========================================================== -->
+          <!-- Loan In fields -->
+          <!-- =========================================================== -->
+
+          <field type="largetext">loansin_common:loanInConditions</field>
+          <field type="largetext">loansin_common:loanInNote</field>
+
+
+          <!-- =========================================================== -->
+          <!-- Loan Out fields -->
+          <!-- =========================================================== -->
+
+          <field type="largetext">loansout_common:specialConditionsOfLoan</field>
+          <field type="largetext">loansout_common:loanOutNote</field>
+
+
+          <!-- =========================================================== -->
+          <!-- Movement fields -->
+          <!-- =========================================================== -->
+
+          <field type="largetext">movements_common:currentLocationNote</field>
+          <field type="largetext">movements_common:movementNote</field>
+
+
+          <!-- =========================================================== -->
+          <!-- Object Exit fields -->
+          <!-- =========================================================== -->
+
+          <!-- Note: schema name is currently singular -->
+          <field type="largetext">objectexit_common:exitNote</field>
+          <field type="largetext">objectexit_common:packingNote</field>
+
+
+          <!-- =========================================================== -->
+          <!-- Organization fields -->
+          <!-- =========================================================== -->
+
+          <!-- Note: schema name is currently singular -->
+          <field type="largetext">organizations_common:shortName</field>
+          <field type="largetext">organizations_common:longName</field>
+          <field type="largetext">organizations_common:nameAdditions</field>
+
+          <!-- FIXME: multivalued field - need to verify schema and field name -->
+          <field type="largetext">organizations_common:historyNotes</field>
+
+
+          <!-- =========================================================== -->
+          <!-- Person fields -->
+          <!-- =========================================================== -->
+          <field type="largetext">persons_common:bioNote</field>
+          <field type="largetext">persons_common:nameNote</field>
+
+
+          <!-- =========================================================== -->
+          <!-- Storage Location fields -->
+          <!-- =========================================================== -->
+          <field type="largetext">locations_common:displayName</field>
+          <field type="largetext">locations_common:name</field>
+          <field type="largetext">locations_common:securityNote</field>
+          <field type="largetext">locations_common:accessNote</field>