HP TRIM source connector

The HP TRIM REST API is supported by HP TRIM content manager 9 and higher.

Supported Features

• Exporting content structure (called "classifications and records" and HP TRIM)
• Exporting versions and revisions
• Exporting binaries
• Exporting users and groups (called "locations" in HP TRIM)
• Exporting audit logs
• Exporting relationships (related records)
• Exporting access control lists

note

This connector does not calculate source.ancestors. If this accelerator is used with the Transformation Accelerator, be sure to run the Calculate Ancestors flow before transformation.

Settings

mongoConnection

The Mongo connection string including the database name to connect to.

hptrimURL

The URL to the HP TRIM service API endpoint.

Example: http://hptrim.con.xillio.com/HPECMServiceAPI

hptrimUsername

The HP TRIM username. This user needs to have read-only access to all the contents that need to be read.

hptrimPassword

The HP TRIM password.

hptrimFileStoragePath

The path where HP TRIM stores the files. Only required when files are not downloaded to the Content Store but retrieved directly from the HP TRIM storage location. Example: C:/HPE Content Manager/ServiceAPIWorkpath/45/EstoreClientCache.

pageSize

Specifies the page size number that is used when paginating.

maxRevisions

Defines the maximum number of revisions to retrieve. This property must be provided for sources running Content Manager 10.1 or later, as the API request differs from earlier versions. When specified, the request is dynamically constructed to use the 10.1+ revisions API. This property must remain empty for sources running versions earlier than 10.1, as those versions do not support the revisions endpoint.

Example: 1000

retrieveAuditLogs

Enables extracting the audit logs on containers and records. Can either be true or false.

retrieveClassifications

Enables retrieving all classifications, stored as RECORD objects. Can either be true or false.

retrieveBinaries

Enables downloading the binaries into the Content Store. Can either be true or false. Please note that in some versions of HP TRIM the API endpoint for downloading revisions is different. Instead of /Record/<recordURI>/RecordRevision/<revisionURI> use /Record/<recordURI>/Children/RecordRevision/<revisionURI>. This can be changed in the HTTP request component in the Download binaries subflow.

retrieveLocations

Enables retrieving all locations, stored as PRINCIPAL objects. Can either be true or false.

retrieveRevisions

Enables retrieving record revisions. Can either be true or false.

retrieveRelations

Enables retrieving all relations on containers and records. Can either be true or false.

retrieveACLs

Enables retrieving all ACLs on classifications, containers, records. Can either be true or false.

getAllRecords

When set to true retrieves all records. Configured rootIds are ignored. Can either be true or false.

rootIds

A list of HP TRIM record rootIds. Can be a Record Uri or Record Number.

Example: [2700, "24/129"]

discardMetadata

Cleans the source.properties object for all stored objects by removing default extracted metadata and unused properties.

Only a minimal set of metadata fields required by schemas and processing logic is retained.

Retained metadata per object type

Containers

For record containers the properties in source.properties is reduced to:

["Fields", "RecordAccessControl", "RecordAssignee.NameString", "RecordAttachedKeywords", "RecordClassification.ClassificationTitle", "RecordCreator.NameString", "RecordDateAssigned.DateTime", "RecordDateClosed.DateTime", "RecordDateReceived.DateTime", "RecordDateRegistered.DateTime", "RecordDocumentStatus", "RecordDocumentType", "RecordHomeLocation.NameString", "RecordIsElectronic", "RecordIsSigned", "RecordKeywords", "RecordLastActionDate.DateTime", "RecordLastPartRecord.NameString", "RecordLatestVersion.NameString", "RecordOwnerLocation.NameString", "RecordRelatedRecs", "RecordReviewStateDate.DateTime", "RecordRootPartRecord.NameString", "RecordScheduledDisposalMethod", "RecordScheduledDisposalStatus", "RecordScheduledInactiveStatus", "RecordTitle", "Uri"]

Records

For documents ("source.contentType.systemName" : {"$ne" : "Classification"}) the properties in source.properties is reduced to:

["Fields", "RecordAccessControl", "RecordAssignee.NameString", "RecordAttachedKeywords", "RecordAuthor.NameString", "RecordCheckedInBy.NameString", "RecordClassification.ClassificationTitle", "RecordCreator.NameString", "RecordDateAssigned.DateTime", "RecordDateClosed.DateTime", "RecordDateReceived.DateTime", "RecordDateRegistered.DateTime", "RecordDocumentStatus", "RecordDocumentType", "RecordHomeLocation.NameString", "RecordIsElectronic", "RecordIsSigned", "RecordKeywords", "RecordLastActionDate.DateTime", "RecordLastPartRecord.NameString", "RecordLatestVersion.NameString", "RecordOwnerLocation.NameString", "RecordPrimaryContact.NameString", "RecordRelatedRecs", "RecordReviewStateDate.DateTime", "RecordRevisionCheckedInBy.NameString", "RecordRevisionRevisionNumber", "RecordRootPartRecord.NameString", "RecordScheduledDisposalMethod", "RecordScheduledDisposalStatus", "RecordScheduledInactiveStatus", "RecordTitle", "Uri"]

For classifications ("source.contentType.systemName" : "Classification") the properties in source.properties is reduced to:

["ClassificationAccessControl", ClassificationActiveFrom.DateTime", "ClassificationApprover.NameString", "ClassificationHomeLocation.NameString", "ClassificationIdNumber", "ClassificationIsActive", "ClassificationIsApproved", "ClassificationName", "ClassificationNotes", "ClassificationOwnerLocation.NameString", "Uri"]

Principals

For principals or locations the properties in source.properties is reduced to:

["LocationActualBarcode", "LocationAfterHoursPhoneNumber", "LocationDateOfBirth.DateTime", "LocationEmailAddress", "LocationFaxNumber", "LocationFirstInitial", "LocationForeignBarcode", "LocationFormalPreamble", "LocationFormattedAddress", "LocationFormattedName", "LocationFullFormattedName", "LocationGenderValue", "LocationGivenNames", "LocationGpsLocation", "LocationHoldingOrganizationName", "LocationHomeDataset", "LocationHonorific", "LocationIdNumber", "LocationInformalPreamble", "LocationInitials", "LocationInternetMailAddress", "LocationIsActive", "LocationIsVisitor", "LocationIsWithin", "LocationJobDescription", "LocationLongHonorific", "LocationMobileNumber", "LocationNickName", "LocationNotes", "LocationOldPostalAddresses", "LocationOldPostalAddressesISO", "LocationOldStreetAddresses", "LocationOldStreetAddressesISO", "LocationPhoneNumber", "LocationPostalAddress", "LocationPostNominal", "LocationSortName", "LocationStreetAddress", "LocationSurname", "LocationSurnameNoPrefix", "LocationSurnamePrefix", "LocationTypeOfLocation", "LocationUnit.NameString", "LocationUserLicenseType", "LocationUserType", "LocationViewPaneId", "LocationWebPage", "Uri"]

Audit logs

For audit logs the properties in source.properties is reduced to:

["HistoryClientIPAddress", "HistoryConnectionIPAddress", "HistoryDoneOn.DateTime", "HistoryDoneOnGMT.DateTime", "HistoryDoneOnLocal.DateTime", "HistoryDoneOnMachine", "HistoryEventDescription", "HistoryEventObject", "HistoryEventType", "HistoryForObjectType", "HistoryForObjectUri", "HistoryIsSecurityViolation", "HistoryLogin", "HistoryLoginLocation.NameString", "HistoryOtherEventType", "HistoryRawEventDescription", "HistoryRecord.NameString", "HistoryTextSummary", "HistoryUpdateComments", "HistoryXmlSummary", "Uri"]

origin

Specifies the origin of the document in the Content Store.