Tab Delimited Data Formatter: Field delimiters and behavior of compound import fields

  • When Content Manager DataPort finds delimiters in the data when exporting it, it modifies them by inserting a backslash character (\) in front of them.

    For example, in the All Contacts field, a name of P3b|2 ;A will look like P3b\|2 \;A in the export file.

    Content Manager DataPort will reverse this modification to P3b|2 ;A on import.

    Therefore, if your import file contains field data that uses either of the two delimiter characters semicolon (;) or pipe(|) , ensure that each legitimate occurrence of the characters within the data has the backslash character (\) directly in front of it.

    This will indicate to the import function to include these in the data in the field, rather than be treated as field delimiters.

Compound Fields

Compound fields contain subsets of data.

Some of these fields also contain multiple sets of data within these subsets.

These fields use a pipe character (|) to separate the subsets of data - that is, the character that separates elements of a compound field.

The Tab Delimited Data Formatter uses a semicolon (;) to separate items within a subset.

For example, the Related Records field:

A record may have multiple related records associated with it. Each related record consists of two elements:

  • Number
  • Relationship Type

The Tab Delimited Data Formatter separates these elements by the semicolon (;) and each related record by a pipe (|) character.

Therefore, a Related Records field will appear as follows:

IsAltIn;2000/05225-02|ContainsClause;G2007/0019|ContainsClause;G2007/0021|RedactionOf;G2007/0016|IsRelatedTo;1985/05109

Compound Fields and their data fields

Movement History

  • TypeOfLocation:
    • Committee
    • Group
    • Organization
    • Person
    • Position
    • ProjectTeam
    • StorageProvider
    • Unknown
    • Venue
    • Workgroup
  • SortName
  • Surname
  • SurnamePrefix
  • GivenNames
  • Intials
  • Nickname
  • IdNumber
  • DateOfBirth
  • DoneOn
  • Login
  • RawEventDescription
  • IsSecurityViolation

Example of Movement History field:

1;The Authority;;;;;GBRMPA;;;5/31/1994 at 3:59 AM;;The Authority ( 31/ 5/ 1994 03:59);False|3;Chairman;;;;;;0001;;6/12/1994 at 10:50 AM;;Chairman ( 12/ 6/ 1994 10:50);False|4;McBinary, Brian (S/Admin) N/A;McBinary;;Brian;B;N/A;;;5/27/2007 at 12:22 PM;trim;McBinary, Brian (S/Admin) N/A (Sunday, 27 May 2007 at 12:21:55 PM);False

Historical Events

Each event is separated by a pipe '|' while each property (or sub field) of an event is separated by a semicolon ';'

The properties of an event are:

  • Audit Type (int) - HistoryTypes enum
  • LocationType (int)
  • LocationSortName,
  • LocationSurname,
  • LocationSurnamePrefix,
  • LocationGivenNames,
  • LocationInitials,
  • LocationNickName,
  • LocationIdNumber,
  • LocationDateOfBirth
  • Audit DateTime
  • Audit Login
  • Audit Description
  • Audit Security Violation

Example of a Historical Events field:

73;;;;;;;;;;5/29/2016 at 3:41 PM;GUEST ACCOUNT;;False|78;4;Abbott, Peter (Mr);Abbott;;Peter;P;;;;5/29/2016 at 3:41 PM;GUEST ACCOUNT;Abbott, Peter (Mr) (At home) (Sunday, May 29, 2016 at 3:41:43 PM);False|79;4;Abbott, Peter (Mr);Abbott;;Peter;P;;;;5/29/2016 at 3:41 PM;GUEST ACCOUNT;Abbott, Peter (Mr) (Sunday, May 29, 2016 at 3:41:43 PM);False|80;4;Abbott, Peter (Mr);Abbott;;Peter;P;;;;5/29/2016 at 3:41 PM;GUEST ACCOUNT;Abbott, Peter (Mr) (Sunday, May 29, 2016 at 3:41:43 PM);False|12;;;;;;;;;;5/29/2016 at 3:41 PM;GUEST ACCOUNT;Email message on 'Svr2012RTMVan.trim.lab' (* Main Document Store: 001+000X+0G440A78004.MSG *);False

Record Holds

  • CaseName

Example of Record Holds field:

Oil Spill Enquiry Hold|Review

Record Jurisdictions

  • JurisdictionName

Example of Jurisdiction field:

JurB\;JurFed1\;JurGroup1\;JursA or JurB;JurFed1;JurGroup1;JursA

RecordThesaurus Terms

  • KeywordName

Example of Record Thesaurus Terms field:

RESEARCH PROJECT|Project [Enter Project Name]|MARINE ANIMALS

Contacts

  • TypeOfContact:
    • Addressee
    • Author
    • Client
    • Custom1 - 10
    • Other
    • Representative
  • TypeOfLocation:
    • Committee
    • Group
    • Organization
    • Person
    • Position
    • ProjectTeam
    • StorageProvider
    • Unknown
    • Venue
    • Workgroup
  • SortName
  • Surname
  • SurnamePrefix
  • GivenNames
  • Intials
  • Nickname
  • IdNumber
  • DateOfBirth

Example of Contacts field:

Author;4;Springfellow, Walter (Sir);Springfellow;;Walter;W;;;|Other;1;Special Broadcasting Service;;;;;SBS;;

Related Records (not to be used for Series - use Record.SeriesRecord)

  • RecordRelationshipType:
    • ContainsClause
    • Custom1 – 10
    • DerivedFrom
    • DoesSupersede
    • InSharepointSite
    • IsAltIn
    • IsAttachmentOf
    • IsRelatedTo
    • IsReplyTo
    • IsRootPart
    • IsTempCopy
    • IsVersion
    • RedactionOf
  • RelatedRecordLongNumber

Example of Related Records field:

IsAltIn;2000/05225-02|ContainsClause;G2007/0019|ContainsClause;G2007/0021|RedactionOf;G2007/0016|IsRelatedTo;1985/05109

First and previous Part

  • RootPartRecordLongNumber
  • PreviousPartLongNumber

Example of First and previous Part field:

2000/05225-01;2000/05225-01

Access Controls

The Access Controls field has information about multiple access controls separated with a | (pipe) with the sub fields separated using a ; (semicolon)

The format of one Access Control is:

integer(Type of Record Access);integer(Access Control Setting);integer(LocationType);string(LocationSortName);string(LocationSurname);string(LocationSurnamePrefix);string(LocationGivenNames);string(Initials);string(NickName);string(IdNumber);string(DateOfBirth)

The Location information is only required if the Access Control Setting is 2 (Private). Where this is not the case the format of one Access Control is simply:

integer(Type of Record Access);integer(Access Control Setting)

  • Type of Record Access (what functionality the access applies to)
    • Accepted values:
      • 1 = ViewDocument
      • 2 = ViewRecord
      • 3 = UpdateDocument
      • 4 = UpdateMetadata
      • 5 = ModifyAccess
      • 6 = DestroyRecord
      • 7 = AddContents
  • Access Control Settings
    • Accepted values:
      • 0 = Public (everyone)
      • 1 = Inherited (Same as Container)
      • 2 = Private (list of Locations)
  • LocationType
    • Accepted values:
      • 1 = Organization
      • 2 = Group
      • 3 = Position
      • 4 = Person
      • 5 = ProjectTeam
      • 6 = Committee
      • 8 = Workgroup
    • Location (Only used if the Access Control Setting is Private)
      • Format of Location field

NOTE: Locations of type 0(Unknown), 7(Venue), and 9(StorageProvider) are not supported location types for access control lists.

Note: Bulk Loading does not support Access Controls so if it has been mapped for importing Bulk Loader mode will be disabled and there will be a note in the log to this effect.

Note: Update on duplicate will replace the record Access Control with the imported value rather than add to it.

Note: When finding a location a search is done using all the Location fields listed (Location type = x AND SortName = x AND Surname = x AND SurnamePrefix = x AND etc.) If there are more than one locations that match the search the first matching location is used. NickName and IdNumber are Unique fields. To be 100% sure you are using the correct location ensure that the Location has a value in one of these fields.

Note: If the Access Control cannot be set for whatever reason, for example a Location referred to on an Access Control cannot be found in the database. No record creation or update will occur and an error will be output to the log.

Example of an Access Control

1;0|2;0|3;2;4;Abbott, Peter (Mr);Abbott;;Peter;P;;;|4;2;4;Abbott, Peter (Mr);Abbott;;Peter;P;;;|5;2;4;Abbott, Peter (Mr);Abbott;;Peter;P;;;|6;2;4;Abbott, Peter (Mr);Abbott;;Peter;P;;;|7;2;4;Abbott, Peter (Mr);Abbott;;Peter;P;;;

Will apply the following Access Controls to a record:

  • View Document; Everyone
  • View Metadata; Everyone

  • Update Document; Private; Person; Mr. Peter Abbott

  • Update record Metadata; Private; Person; Mr. Peter Abbott

  • Modify record Access; Private; Person; Mr. Peter Abbott

  • Destroy record; Private; Person; Mr. Peter Abbott

  • Contribute Contents; Private; Person; Mr. Peter Abbott

Location relationships

  • LocationRelType
  • TypeOfLocation:
    • Committee
    • Group
    • Organization
    • Person
    • Position
    • ProjectTeam
    • StorageProvider
    • Unknown
    • Venue
    • Workgroup
  • SortName
  • Surname
  • SurnamePrefix
  • GivenNames
  • Intials
  • Nickname
  • IdNumber
  • DateOfBirth

Example of Location Relationships field:

MemberOf;3;Director Education and Information;;;;;;0008;|MemberOf;1;Education and Information;;;;;EDUCINF;;

Location Addresses (only supports the current addresses)

  • AddressType:
    • Postal
    • Street
    • Custom1 - 5
  • AddressLines
  • AddressCity
  • AddressState
  • AddressPostcode
  • AddressCountry
  • AddressRegion

Example of Location Addresses field:

0;14 Bunbary Court;Canberra;ACT;2601;Australia;|1;PO Box 4422;Canberra;ACT;2601;Australia;

Electronic Addresses

  • ElectronicAddressType:
    • Mail
    • Url
  • ElectronicAddressData
  • Description
  • EmailAddressTypeString
  • IsPreferred

Example of Electronic Address field:

0;CM@towersoft.demo;Demo;SMTP;No|0;/O=TOWERSOFT/OU=CM/CN=CM;Demo;EX;No

Related Thesaurus Terms

  • KeywordRelationshipType:
    • Broader
    • Narrower
    • RelatedTo
    • Use
    • UseFor
  • KeywordName

Example Related Thesaurus Terms field:

UsedFor;ENTRY FEES|Broader;AQUARIUM|RelatedTo;AIR QUALITY|RelatedTo;MARINE ANIMALS|RelatedTo;MARINE PLANTS|Narrower;Project [Enter Project Name]|Broader;RESEARCH PROJECT

Active Date Range

  • ActiveFrom
  • ActiveTo

Example Active date range field:

02/28/2010|12/29/2012

Triggers

  • RecordDisp:
    • Active
    • Archived
    • Destroyed
    • Inactive
    • Transferred
  • AfterYears
  • AfterMonths
  • TriggerType:
    • ContentDateClosed
    • ContentDateCreated
    • ContentDateFinalized
    • ContentDateLastAction
    • ContentDateModified
    • DateArchived
    • DateClosed
    • DateCreated
    • DateFinalized
    • DateInactive
    • DateLastAction
    • DateModified
    • DateRegistered
    • FixedDate
    • LastPardDateClosed
    • LastPartDateCreated
    • RootDateCreated
    • UserDefined
  • TriggerRounding:
    • EndOf<Month>
    • StartOf<Month>
    • EndOfCalendarYear
    • EndOfFiscalYear
    • EndOfHalfYear
    • EndOfQuarter
    • NoRounding
  • FixedDate
  • UserdefinedDate
  • Jurisdiction

Example of Triggers field:

Inactive;2;0;DateClosed;NoRounding;;;|Destroyed;6;0;DateInactive;NoRounding;;;|Transferred;5;0;DateFinalized;NoRounding;;;JursA

Active Date Range

  • ActiveFrom
  • ActiveTo

Example of Active date range field:

07/26/2007|07/23/2011

Member Jurisdictions

  • JurisdictionName

Example of Member Jurisdictions field:

JursA|JurB

Lookup Set

  • Name
  • Notes
  • AccessControl
  • IconId
  • Lookup Set Item DisplayStyle
  • Lookup Set Items HaveComments
  • Lookup Set Items HaveHierarchy
  • Lookup Set Items HaveLongValue
  • Lookup Set Items HaveShortValue
  • LongValueMaxLength
  • OnlySelectLowestLevel
  • ShortValueIsNumeric
  • ShortValueMaxLength

Lookup Items

  • ParentSet
  • Abbreviation
  • Name
  • Comments
  • AccessControl
  • Description
  • FullDescription
  • IconId
  • ItemNumber
  • ParentItem

Example of a Lookup Set with Lookup Set items import:

Dataport test;;Item1;;Item1;Item1;0;0;|Dataport test;;Test2;;Test2;Test2;0;0;|Dataport test;;LSItem3;;LSItem3;LSItem3;0;0; Dataport test 0;0|1;0|2;0|3;0 0 0 False False True False 255 False False 0

Example of Lookup Items import:

0 0 Item1 Dataport test 0;2;4;Abramovic, Zelman (Mr) MYE;Abramovic;;Zelman;Z;;;|0;2;4;Abbey, Rhoda (Ms);Abbey;;Rhoda;R;;;|1;2;4;Abramovic, Zelman (Mr) MYE;Abramovic;;Zelman;Z;;;|1;2;4;Abbey, Rhoda (Ms);Abbey;;Rhoda;R;;;|2;0|3;0

Active Date Range

  • ActiveFrom
  • ActiveTo

Example of Active date range field:

07/17/2007|07/23/2011