Micro Focus Content Manager SDK 9.4
Release Notes

Table of Contents

Content Manager 9.4

Hide records and record types for customized SDK applications - doesn't work

ER KM03300730

New property

Unrestricted File Upload Vulnerability

New method

Refine a search to returned the current or latest version of documents

New properties

Include more functionality to handle deleted and cancelled record requests and audit all actions

ER KM03312951

Enum item

Record Title as column in historical event search

ER KM03312945

New property

No email notifications for requested records located in Space Management

ER KM02341639

New properties

Online Audit log - The audit history does not include all changes when a person location is associated to a position

ER KM03106774

New property

Provide a default for the author property for a Document Queue

New property

Automatic Sub folders sort order for Record Types

ER KM03264856

New property

Search for records has no Hold returns records has Hold

ER KM03346778

New property

Expose RestartDocumentReview to the SDK

New method

Searching Browse Via Classification - ability to select a sort method for listed records under Classifications

ER KM03216957 ER KM1345606

Removed property

  • RecordSortOrder

New properties

HasMore property on TrimMainObjectSearch

Improved way to determine whether there are more objects in the search. Typically of use in a web application where results are returned page by page.

New property

Expose ChangeMatter and ChangeClient functionality in SDK

New methods

Knowledge workers can't request Pickup Requests

New permission to give knowledge workers the ability to make pickup requests.

New Enum value

  • UserPermissions.MakePermanentRetrievalRequests

Implement a generic origin type for third party applications to use for bulk loading

Existing origin types are targeted to specific uses. the new Origin type is appropriate for SDK bulk loader applications.

New Enum value

  • OriginType.Generic

SDK Release as NuGet package

The Nuget package is intended for developers, and contains a minimized set of DLL's needed for developing applications using the Content Manager SDK. It does not contain KeyView components, or other third party components.

For developers requiring the full set of Content Manager DLL's, it is recommended to run the Content Manager server or client installation packages.

To use the Nuget package from Visual Studio, please follow these directions: 

1) In Visual Studio, select Tools -> Options.
2) Select Nuget Package Manager -> Package Sources.
3) Click the green Add button, and add the location of this folder.
4) In the Solution Explorer, right click on your C# project, and press "Manage Nuget Packages".
5) In the "Package source" drop down box, select the package source you configured in (3).
6) Click on Browse.
7) Click on the "HP.HPTRIM.SDK" package.
8) Press Install, to add it to your project.

Provide a way of doing server side updates in a custom event processor and preserving the lastUpdatedBy (and datelastUpdated) fields

ER KM03477884

New property

Expose SDK connection pool configuration

New class

Auto Profiling - provide a per-record option to choose the record title from the document properties or the document file name

ER KM03140523

Properties removed

  • MailRecipientMustExist
  • MailRecipientsAsContacts
  • SuppressAutoProfile

New properties

Add access control to User Labels

ER KM02782530

New properties

Resolve ambiguities as to who can see a classification

ER KM03469504

New properties

Issues with "Due Date for completion of review process" and "Due Date for the reviewer to complete their work" fields.

ER KM02852768

New properties

Allocate a custom title to an alert.

ER KM02739810

New properties

Unable to send more than 100 Records at a time to External Link

ER KM02904803

An executable external link passes the selected Record URI's as a command line parameter, Windows restrictions means there is a limit to the size of the command line parameter. The new option 'send tagged URI's as a temporary file' causes the list of selected URI's to be written to a file and the name of the file is passed to the executable as demonstrated in this sample.

Automatic Sub folders sort order for Record Types

Automatic sub folders can now be ordered to produce new folders in the same sequence.

ER KM03264856

New properties

  • SequenceNumber

Search for records has no Hold returns records has Hold

ER KM03346778

New properties

Specify which record type is allowed to be placed into closed containers

ER KM03438056

New properties

Add Notes to User Labels

New properties

New methods

Check-in Styles and Document Queues to include additional options

ER KM02801731 ER KM03209226

New properties (CheckinStyle)

New properties (DocumentQueue)

Send to Recycle Bin - Soft delete for Records

ER KM02900246

New methods

New properties

Hide records and record types for customized SDK applications - doesn't work

Ensure that TrimMainObjectSearch operates in the same way as the native CM application to hide RecordTypes marked with an ExternalId.

ER KM03300730

New property

Folder Synchronization - provide a way of detecting when content is removed from a folder for offline synchronization purposes

To sync the contents of a large folder, without re-fetching the entire contents, you need to get:

  • newly added Records, which can be done using a search, and
  • records removed (via deletion or movement), which can be done with this new method.

New method

Provide a data stream capability to avoid delays caused by object cache instantiation

See the documentation for sample code using stream search.

New classes

New method

Implement new Record methods for closing (and reopening) containers

New methods

Searches to be able to filter / clause based on enum

Rather than having to use the string representation of an enum item you can now set the actual enum value on the TrimSearchClause, as seen here.

New method

Need a way to inform SDK applications of object change notifications and other system messages

The CM client uses a subscriber service provided by the workgroup to keep caches up to date with changes that happen on other machines in the network. This enhancement allow SDK applications to be notified when an object in CM has changed. A use case for this might e to refresh a client side cache.

See the documentation for more information and sample code.

Content Manager 9.3

SDK no longer installed in GAC

In previous versions the .Net has been installed in the GAC. This is no longer the case. To support dynamic loading HP.HPTRIM.SDK.dll follow the pattern demosntrated in this sample.

Removed properties

The following properties are no longer required and have been removed from the SDK:

  • CommunicationDetail.AddressUri
  • Database.AutomaticallyOCR
  • Database.IdolSearchStyle
  • GisDataUserOptions.SeachPreference

Audits - Unable to see the Audit log for the records placed on hold as a group

You can now specify whether you want audit log entries when using the Bulk Add/Remove to hold feature.

CR 64234

New methods

Record import not working when lookup item additional field is on a record

CR 65057

New methods

Property on Offline Record object to tell us whether auto checkin has is enabled

CR 65921

New methods / properties

Consignments

You can flag transfer or archive consignments to have all documents in the consignment converted to the long-term preservation format.

CR 64782

New methods / properties

History

Content Manager now supports keeping a log of all searches undertaken. If stored to the online audit log, these a can now be selected to be executed again at a later date.

CRs 66129, 58614

New methods / properties

RecordAction

CR 65586

New methods / properties

Retention Schedules - provide support for event based scheduling

Some preliminary work has been done to support event-based retention scheduling. This has not yet been implemented fully in Content Manager and the work will be completed in the next major release. Events can be created however they cannot be associated with a retention schedule or used for disposal scheduling of records. Consider these objects “reserved for future use”.

CR 57424

New objects

View Panel - Add the To Do items in record View Panel

CR 62404

New methods / properties

Record Type

CRs 65336 66968

New methods / properties

Database

CRs 64463, 65867, 58614, 59359, 57362, 64305

New methods / properties

Renamed properties

Request

CR 65586

New methods / properties

UserLabel

CR 65044

New methods / properties

DroppedFileUserOptions

CR 62258

New methods / properties

Ability to manage favourite and recent search clauses in user profile

CR 62670

New objects

Providing a custom sort order specifically for Tray searches

CR 61994

New objects

Content Manager 9.2

Checking for duplicate documents by hash

CR 62066

New methods / properties

New hashing related methods and properties are:

Comments

While it was possible to enable duplicate checking in the system options there was no programmatic way to check for uniqueness of a document using its hash, two new SDK methods support this. CalculateDocumentHash will calculate the hash for a local file and FindRecordsByHash will find any Records with documents that match the hash.

For systems that have previously use hashing for de-duplication existing hashes will be stored against Records on upgrade, otherwise after hashing is enabled only newly created Records will have a hash stored against them. CalculateHash may be used to retrospectively calculate hashes.

Sample Code

The following code:

  • generates a hash for a local file,
  • finds any Records that match this, and
  • notifies the user whether (or not) there are matching Records.
try
{
string hash = db.CalculateDocumentHash("c:\\temp\\temp.doc");
TrimMainObjectSearch recordSearch = db.FindRecordsByHash(hash);
List<string> numbers = new List<string>();
foreach (Record rec in recordSearch)
{
numbers.Add(rec.Number);
}
if (numbers.Count > 0)
{
Console.WriteLine(string.Format("This document '\\temp\\abc.doc' is already registered, Record(s) = {0}", string.Join(", ", numbers)));
} else
{
Console.WriteLine("The document '\\temp\\temp.doc' is not registered in TRIM");
}
}
catch (TrimException ex)
{
Console.WriteLine(ex.Message);
}

Searching for Record types: 'can contain' and 'can be contained in'

CR 61825

New Search Clauses

Two new search clauses make it simpler to find the correct Record type when creating a contained (or container) Record.

Updates to Lookupsets

CR 61030

New methods / properties

New LookupSet and properties are:

New LookupItem methods and properties are:

New LookupItem search clauses

Comments

Lookup Sets have changed significantly and the properties (and methods) reflect this, changes include:

  • hierarchical lookup sets: find child items via the search clause LookupItemParent
  • LookupSet type additional fields: use these fields to store a reference to the exact LookupItem rather than relying on the string value of the LookupItem

Issues with constructors

CR 61030

Comments

Some of the TrimMainObjects had issues with their constructors which have been fixed, these included:

  • Alert object would construct successfully but no alert appeared in the client.
  • RecordAction and Word had a constructors for creating new instances, these have been removed.

Sample Code

The following example creates a new Alert.

Alert alert = new Alert(db);
alert.ObjectType = BaseObjectTypes.Record;
alert.EventType = Events.ObjectModified;
alert.Criteria = "electronic";
alert.ChildSubscribers.NewSubscriber(new Location(db, 9000000049));
alert.Save();

IsValidFor throws an exception rather than returning false with information

CR 60946

Comments

Rather than returning false when a particular purpose was not valid IsValidFor was throwing an exception.

Sample Code

The code below calls IsValidFor on a Location.

Location loc = new Location(db, 1);
loc.IsValidFor((int)LocationPurpose.AddToBossOf);

Promote Revision function that works like the functions inside trim.exe

CR 60986

Comments

Ability to promote a revision to be the main document as could already be done through the native client.

Sample Code

Choose a particular record revision then promote it.

Record rec = new Record(db, 9000000000);
RecordRevision revision = rec.ChildRevisions.FindChildByUri(9000000001) as RecordRevision;
revision.Promote();

Database pool built into SDK

CR 61192

Comments

Calling Database.Connect() can take several hundred milliseconds to complete. This is not a problem in a client application where the connection is preserved for the life of the application but for a web service application it adds significant overhead to each request. The database pool optimises this connection process by storing each instance of the database in a cache and then on subsequent requests retrieving the cached instance instead of connecting a new instance.

Database pooling operated transparently as long as the database is connected in the appropriate way, as seen in the sample below.

New methods

Two scenarios where the pool should be flushed to prevent the usage of a stale connection are when a user option is changed or when SetDataGridVisiblePropertiesOrFields is called.

  • FlushConnectionPool

Sample Code

The database instance will be cached if a workgroup server name, trusted user and database Id are specified. The instance will remain in the cache for 5 minutes.

Database db = new HP.HPTRIM.SDK.Database())
db.Id = "K1";
db.TrustedUser = "fred";
db.WorkgroupServerName = "local";
db.Connect();

Provide a HasPermission function for the TRIM main object

CR 61398

New methods

New methods are:

Comments

New methods to determine whether a user has the ability to perform certain actions in general and on specific objects and properties.

Prevent invalid extensions from interfering with the checkout process

CR 62054

Comments

Putting invalid characters in CheckInAs would cause an error when check the document out, these characters are now stripped from the file name on check out.

SDK methods to support field sorting

CR 62763

New methods / properties

New method and property are:

Comments

User defined fields are now sortable and the CanSort function allows a developer to determine whether a particular field is sortable.

SDK methods to support blocking of search methods

CR 63439

New methods / properties

New methods provided:

Comments

A system administrator can choose to "block" certain searching methods from normal users. When this happens, it is expected that these methods will not be presented in user interfaces for the currently logged in user. To assist in implementing such user interfaces, the extra methods above have been provided to allow SDK developers to filter out such blocked search methods.

Exposing the Initiating Workflow template concept in the SDK

CR 64493

New methods / properties

New methods provided:

Comments

This new property has been added in order that SDK applications can specify that a workflow be generated as part of the process of creating a new record. To do that you need to specify a valid workflow template in this property - the new workflow will be created based on that template. Note that this property is a little special in that it cannot be set for an existing record - if you try to do that you will get an error. It really is only applicable for new records. The value of the property is also "forgotten" once the record has been created.

Provide a way of "crawling" the repository without tripping the dateLastUpdateOn date

CR 64506

New methods / properties

New properties provided:

Comments

This boolean property of ExtractDocument has been provided so that you can write an application that extracts a copy of a record's document without setting the DateLastAction property of the Record. Typically the act of extracting a document can be seen as an "action" on a record and so the DateLastAction is set, together with a consequential update to the DateLastUpdatedOn property. If you turn it on, this property overrides the RecordType setting for "Set Last Action Date On View". It is useful for writing an app that must periodically check and extract any new content, and is relying on the DateLastUpdatedOn property to find recently updated records.