CSPACE-3053: Updated read me file with a first pass at designating 'largetext' fields...

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