The 'All' property set in the ServiceAPI


In the ServiceAPI there is a concept of a propertySet, this allows for the retrieval of a pre-defined set of properties, for example:


The problem with 'All'

One of the property sets is 'All' which means that the above URL could look like this:


Fetching all properties for many object types (such as Classification, SavedSearch, Activity etc) can be a good idea, being simpler than pre-determining which properties you need.  Using 'All' for Records is problematic, two problems being:

  • some Record properties are very expensive so response times will be unnecessarily slow, and
  • some properties will throw an error if the related feature is not enabled (e.g. NextTaskDue requires the Vital Records feature be enabled).

The solution

The solution is not to use 'All'. The alternatives are:

  • use the 'ViewPane' property set instead, which returns a list of all properties that might be interesting to an end user, or
  • construct a custom property set in hptrim.config which can contain all the properties that are of interest to your application.

Creating a child object (Record 'Alt in' Relationship)

The code

To add a new object to one of the child object collections on a TrimMainObject, for example adding a RecordRelationship to a Record, requires sending an array containing one or more objects to the appropriate collection. For Example, posting the code below to the Record endpoint will cause Record 9000000002 to be 'Alternately contained within' Record 9000008050.

        "RecordRelationshipRelationType": "IsAltIn"

And a video...

Using a search query instead of a Uri in a URL

Recently I wanted to link to a Record using the external ID, not the Uri or the number.  This was from a customised WeDrawer page so I could have done a search to find the Uri and then used that, but I didn't want that extra step.  A little reflection (and poking around in the code) and I realised that I could use the external id in the URL after all.

If it was a search

A search by external id would look like this, problem was I want to open the actual record page, not a list of one record.


As a URL

As long as a search returns only one result then you can substitute the query for the Uri in the URL, as long as you can compose the query without using a colon (colons are reserved characters in URLs).  So below I use equals instead of colon to either open the details page or go directly to the document via the external id.



As is my habit I use the internal name for the search clause (recExternal) not the name (external) to minimise the possibility of breakages due to either custom captions or use of different languages.

SAML signout


In a previous post I show how to use Component Space to add SAML support to the Web Client, here I add a sign-out button.


useADFS == true

Set useADFS to true in hprmServiceAPI.config, for example:

<setup databaseId="J1"  searchAhead="false" advancedSearch="false" workpath="C:\HP Records Manager\ServiceAPIWorkpath\Uploads" useADFS="true"/>

Setup signing certificate

If you plan to sign your logout request then you will need a certificate, either encrypt the password or store the certificate in the Windows certificate store as described in this Component Space document.

Add keep-alive

To allow for notification when the user's session has expired add the keep alive loop.  To do this edit _Initialisation.cshtml (or _Shared.cshtml in later versions) and comment out the RMStayALive function, then add this new version:

var RMStayALive2 = function () {
    var makeRequest = function () {
        $.getJSON(HP.HPTRIM.TrimClient.getServiceAPIUrl() + "/Location/me", function (data, status, xhr) {
        }).fail(function () { 
            if (confirm("Your session has expired, do you wish to re-authenticate?")) {
                top.location = HPRMWebConfig.virtualDirectory;
    setInterval(makeRequest, (60 * 1000));



The process above is shown in this video.

Capture all email using Email Manager


Occasionally you might want to capture all email sent by (and to) particular users.  This is achieved using a combination of Exchange Journaling and the Content Manager 'Email Management' module. 


There are a few things that need to be done in order to use the Email Management import tool, these are:

  1. setup an SMTP server which can store incoming email in a drop folder, probably the IIS SMTP server,
  2. configure journaling on your Exchange server to journal email to your SMTP server, and
  3. configure an Origin in Content Manager to monitor the drop folder on the SMTP server.


In this video I take a tour of Content Manager Email Management installed on an Azure VM and using Exchange Email Online.

NOTE: In the video I state the bulk loading is not supported when using SQL Azure.  I am reliably informed that this has been fixed in Content Manager 9.2.

Java ServiceAPI and additional fields

Previous posts have described the Java client and file upload.  This post details how to fetch the value of additional fields.

Field Names

As described elsewhere the name to use to fetch an additional field is its search clause name, as seen in the client.


Get field values as text

Once you know the correct names for your fields you need to fetch them.  A full sample is provided in the samples repo, in short you need to:

  1. request the fields by name
  2. request string values be returned
  3. parse the string value as necessary.


See the samples repo for the full sample. 

Records request = new Records();
request.q = "number:rec_222";
// tell the search request to return both string and actual values for the fields and properties

request.Properties = makePropertyList("RoadSurface", "DateOfIssue", "PoliceOfficer");

RecordsResponse response = client.get(request);
Record rec = response.Results.get(0);

ITrimProperty dateOfIssue = rec.Fields.get("DateOfIssue");

SimpleDateFormat parser = new SimpleDateFormat("EEE, d MMM yyyy HH:mm:ss zzz");
Date date = parser.parse(dateOfIssue.getStringValue());

Database connection caching

Previously if you wanted to avoid the overhead of Database.Connect() in a web service application you had to write some sort of connection pool. In 9.2 this is no longer required as the SDK itself caches connections.  The requirements are that:

  • the previous connection must be Disposed,
  • the subsequent connection must have the same Database Id, work group server name  and trusted user.

Sample Code

private static Database getDatabase(string user = null)
    Database database = new Database();
    database.WorkgroupServerName = "local";
    database.Id = "L1";
    if (user != null)
        database.TrustedUser = user;


    return database;

private static void connectDatabase()
    string trustedUser = "itu_tadmin";
    using (var db = getDatabase(trustedUser))

    using (var db2 = getDatabase(trustedUser))

    using (var db2 = getDatabase(trustedUser))

static void Main(string[] args)
    TrimApplication.TrimBinariesLoadPath = @"Your bin folder";




Event Filtering in 92

Event processor add-ins are great for responding to events on the workgroup server but and now we can optimise them to only respond to the events (and object types) that we are interested in.  Use the 'Configure Events' button in the  'Custom Processes' tab in Enterprise Studio, or watch this video for more information.  For more details on the event processor addins see my previous post and the sample.

Where to store config, web.config or not...

For those who customise WebDrawer on one machine and then push it to a production machine this may prove handy.  I wanted to change the setup of IIS on my dev machine to not update the web.config when I change the authentication settings.  Here is what I did...

1. Go to Feature delegation in IIS Manager


2. Select Custom Sites


3. Set the authentication settings to Read Only


4. Clean modified web.configs

Remove the <security /> section from all web.config files that have already been updated, otherwise you will get an error when you attempt to open these applications.  Also check c:\inetpub\wwwroot\web.config to ensure that authentication has not been set here.

5. Update applications in IIS

Go through each application in IIS and ensure the authentication settings are correct, this will update applicationHost.config.


Setting these settings to Read Only prevents them being updated in the application specific web.config, instead they will be set in the applicationHost.config

Email Link - Delete Check in Style

The CM Rambler showed how to improve the Email Link Admin console, this post shows how you might add a facility to delete a user's Check in Style from within the admin console.  My main motivation for this is that there is a version of Content Manager out there which makes it difficult for a user to delete a user's check in style from the client, which is a problem when, for example, a user leaves the organisation.


The code

As per the video above

An empty TH


A table cell containing a button

<td><button class="btn btn-small" data-place-uri="@record.Uri">Delete</button></td> 

The script

$("button[data-place-uri!=''][data-place-uri]").on("click", function (event) {
    var placeUri = $(this).attr('data-place-uri');

        url: "CheckinPlace?q=Uri:" + placeUri + "&resultsOnly=true",
        data: {
            properties: "CheckinPlaceCheckinAs"
        dataType: 'json'
    .done(function (data) {

        for (var n = 0; n < data.Results.length; n++) {
            var place = data.Results[n];

            if (place.CheckinPlaceCheckinAs) {
                    url: "CheckinStyle/" + place.CheckinPlaceCheckinAs.Uri + "/Delete",
                    type: 'POST',
                    dataType: 'json',
                    contentType: 'application/json'
                .done(function (response, statusText) {
                    if (statusText === "success") {



Upload a file and create a new revision

I just added a new sample to the documentation that ships with the ServiceAPI.  In the mean-time here it is, the two step process to first upload a file and then use it to create a new Rendition on a new Record.

You could also use Record.FilePath to use the uploaded file to create the electronic document for the Record itself.

FileInfo fi = new FileInfo("c:\\junk\\test.pdf");

var fileResponse = client.UploadFile(fi, System.Web.MimeMapping.GetMimeMapping(fi.Name));

Record rec = new Record();
rec.RecordType = new RecordTypeRef() { Uri = 2 };
rec.Title = "test";

rec.ChildRenditions = new List();

rec.ChildRenditions.Add(new RecordRendition()
    TypeOfRendition = RenditionType.Longevity,
    FromFileName = fileResponse.FilePath,
    Description = "my PDF rendition"

FileInfo mainFile = new FileInfo("c:\\junk\\test.docx");

var response = client.PostFileWithRequest(mainFile, rec);

foreach (Record record in response.Results)

Custom Authentication

A couple of years I wrote a post describing Google authentication in the ServiceAPI.  This is an update of that.  The details are in the samples repo and here is a video of me applying the sample from the repo to a WebDrawer and Web Client instance.

Other authentication providers

Remember the repo contains a link the ServiceStack documentation which provides assistance for using (and creating) other authentication providers.

String Search parsing and filtering

Sometimes I overlook some pretty important things.  I realised recently that I had missed an interesting behaviour of the TrimMainObjectSearch string searching.

A valid search with filtering

The search below will search for all records where the Additional Field 'Alcohol Level' is greater than zero and filter on Record Type == "Infringement".

TrimMainObjectSearch recordSearch = new TrimMainObjectSearch(db, BaseObjectTypes.Record);

foreach (Record record in recordSearch)

An invalid search without filtering

This search is invalid because 'Alcohol Level' is a number field, so no results are returned, everything is good so far.

TrimMainObjectSearch recordSearch = new TrimMainObjectSearch(db, BaseObjectTypes.Record);

foreach (Record record in recordSearch)

An invalid search with filtering

You might expect that the search below would behave just as the search above and return no results, given the invalid search string, this is not the case.  The invalid search string is discarded and the filter is applied, the result is all Records where Record Type == 'Infringement'. 

TrimMainObjectSearch recordSearch = new TrimMainObjectSearch(db, BaseObjectTypes.Record);

foreach (Record record in recordSearch)

The solution

To avoid this problem always check the return value of SetSearchString().

TrimMainObjectSearch recordSearch = new TrimMainObjectSearch(db, BaseObjectTypes.Record);
TrimParserException parserException = recordSearch.SetSearchString("AlcoholLevel>abc");

if (parserException.Bad)

    foreach (Record record in recordSearch)

Filter WebDrawer Search Forms

Lets say you have designed multiple search forms which are used via WebDrawer.  These forms provide different fields with which to search.  In addition to this you may also want to filter the results for each form to make them appropriate for the target audience.

Embedding the filter

One approach is to embed a filter based on the search form name. I did this by:

  1. editing Views\Search.cshhtml
  2. enable 'Name' retrieval for the search form
  3. add a filter field based on the name.

Name retrieval

Near the top of Search.cshtml you will see code that looks like this

searchForm = TrimHelper.Search<SearchForm>(
    properties: new string[] { "ObjectType", "DefinitionForm" }).FirstOrDefault();

Add the property 'Name' in the propert list, so that it now looks like this:

searchForm = TrimHelper.Search<SearchForm>(
    properties: new string[] { "ObjectType", "DefinitionForm", "Name" }).FirstOrDefault();<p>Hello, World!

Add the filter

Further down the page is found the search form itself, starting with this HTML:

<form id="search-form-form" class="form-horizontal search-form" action="FormSearch" method="GET">

After this line add some code to insert a filter INPUT element, potentially different for each search form.  The code below add a filter for the search form named 'Test Form'

@if (searchForm.Name == "Test Form")
    <input type="hidden" name="filter" value="recType:Document" />


This is a convenience, not a security measure.  For example a user could still modify the URL resulting from this search to avoid the filtering.