CSSearchMultiple

The CSSearchMultiple class searches an iCM, site, or custom search collection for the specified search terms or keywords.

This documentation describes the methods and properties available to use via the API Server's iCMAPI Worker. If you are working directly with the iCM.NET or iCM4j APIs, consult the documentation for your framework. The main difference being the various add methods available in the standard APIs, whereas the iCMAPI Worker requires everything to be done via the properties of the get request.

The following search collections are maintained by iCM. For more information about how the items in each collection are indexed see the Search Indexing article.

The Advanced Searching with CSSearchMultiple knowledge base articles include example forms that demonstrate faceting, grouping and location based searches. They use filter queries, group queries, SOLR functions as search commands, and show how additional SOLR parameters can be included in your requests.

For user-defined collections, search results will depend on the information contained within the collection. The key information inserted for each item within the user-defined collection must be in the format <Item ID>_<Item Type>, where 'Item ID' is the item's unique identifier and 'Item Type' is the label that identifies the item's type.

Methods

CSSearchMultiple_get

Performs the search. Due to the wide range of properties that can be used to restrict/refine the search, they won't all be repeated here, just those that are required are listed, followed by some examples. See the relevant knowledge base articles for more detailed examples.

Request Parameters

Keywords

The Keywords property searches the collection for a space delimited set of keywords. The default operator is OR. Round brackets can be used to group keywords. Double-quotes can be used to wrap a keyword or set of keywords indicating that they should be treated as an exact phrase. Searching is case-insensitive, meaning that a keyword of Film will match against film, Film and FILM.

By default stemming is enabled, so a keyword of film will return film, films, filming, etc. Double quotation marks can be used to wrap an individual keyword if stemming is not required in that particular instance. Stemming can be turned off completely by setting the KeywordStemming property to false.

SearchCommand

The SearchCommand property overrides the keywords property and can be used to construct complex queries where the default properties do not meet your requirements. The search command is passed directly to the SOLR engine. Using SearchCommand ignores other properties that may restrict the search, like root groups and IDs or subsite restrictions. It's possible to retain some content restrictions using the SearchCommandAction property (see below).

Example Request - Return All

In this request we are searching the solrsite article collection for any articles with the word Tim in. You need to request all if you want the information in each CSSearchItem to be returned.

client.invoke("icmapi", "CSSearchMultiple_get", {
    "set": {
        "CollectionNameList": "Article",
        "LuceneRepositoryPath": "http://localhost:5506/solrsite",
        "Keywords": "Tim"
    },
    "get": "*"
});

Response Properties

Example Response - Return All

Two results have been found.

"result": {
    "data": {
        "multipleItemData": [{
            "ParentData": ",154,1,0",
            "CreationDate": "2018-02-14T10:42:19Z",
            "_ItemClass": "CSSearchItem",
            "GroupKey": "Article154",
            "Title": "Tim's Article",
            "Url": "",
            "Custom3": "1",
            "Score": 17.848412,
            "Type": "Article",
            "Custom2": "",
            "Custom1": ",154,1,0",
            "ModificationDate": "2018-02-14T10:42:19Z",
            "MetaData": "",
            "DynamicFields": {
                "OBJECT_C__title": "Tim's Article"
            },
            "Summary": "This is the summary text This is the body text",
            "Key": "154"
        }, {
            "ParentData": ",155,1,0",
            "CreationDate": "2018-02-14T10:42:54Z",
            "_ItemClass": "CSSearchItem",
            "GroupKey": "Article155",
            "Title": "Tim's Article with Metadata",
            "Url": "",
            "Custom3": "1",
            "Score": 14.278729,
            "Type": "Article",
            "Custom2": "1",
            "Custom1": ",155,1,0",
            "ModificationDate": "2018-02-14T10:42:54Z",
            "MetaData": "1",
            "DynamicFields": {
                "OBJECT_C__title": "Tim's Article with Metadata"
            },
            "Summary": "This is the summary text This is the body text",
            "Key": "155"
        }],
        "itemData": {
            "SearchHandler": "",
            "EnableDidYouMean": false,
            "KeywordOROperators": "",
            "_ItemClass": "CSSearchMultiple",
            "Server": null,
            "GroupQueries": [],
            "GroupField": "",
            "Port": 0,
            "LuceneRepositoryPath": "http://localhost:5506/solricm",
            "GroupTruncate": false,
            "RootArticleIDs": "",
            "FacetDateStart": "NOW/YEAR",
            "MediaGroupNames": "",
            "MediaTypeNames": "",
            "RootProductGroupIDs": "",
            "CollectionNameList": "Article",
            "GroupList": "",
            "CachingEnabled": false,
            "FieldFacets": {},
            "SolrPageSize": 500,
            "QueryFacets": {},
            "SolrResultCount": 2,
            "LastModifiedEndDate": null,
            "FacetFieldPrefix": "",
            "DatabaseVersion": 10.0006,
            "MediaMetaDataOptionalIDs": "",
            "FacetQueries": [],
            "SolrStartPosition": 0,
            "KeywordNOTOperators": "",
            "Timeout": 5000,
            "MinFacetCount": 1,
            "SolrParameters": [],
            "PropertyFile": "./etc/dbprops.dat",
            "GroupLimit": 2147483647,
            "ApproxTotalResults": 2,
            "LastModifiedStartDate": null,
            "SubsiteID": 0,
            "DetailLevel": 4,
            "SummaryAction": 1,
            "DidYouMean": "",
            "RecordedGatewayMessages": [],
            "MaxRows": 50,
            "UseCache": false,
            "RecordGatewayMessages": false,
            "RootProductRackIDs": "",
            "SearchCommandAction": 0,
            "HighlightingEnabled": false,
            "KeywordStemming": true,
            "Keywords": "Tim",
            "VerityRestartPosition": 1,
            "ClusteringField": "",
            "MaxFacets": 10,
            "DateFacets": {},
            "RootMediaGroupIDs": "",
            "FieldConstraints": [],
            "RootThreadIDs": "",
            "More": false,
            "MediaMetaDataIDs": "",
            "FilterQueries": [],
            "UserID": 0,
            "ArticleMetaDataOptionalIDs": "",
            "FacetFields": [],
            "BoostSearch": true,
            "FacetDateGap": "+1MONTH",
            "CaseSensitive": false,
            "SearchCommand": null,
            "GroupOffset": 0,
            "KeywordANDOperators": "",
            "FacetDateEnd": "NOW",
            "FacetDates": [],
            "KeywordOperator": 1,
            "RootForumIDs": "",
            "Preview": false,
            "SearchEngineRestartPosition": 1,
            "SortOrder": "",
            "StartRow": 1,
            "ArticleMetaDataIDs": "",
            "ColdFusionVersion": 0,
            "FacetParameters": [],
            "UseLuceneCollections": true,
            "DebugOutput": false,
            "DisplayDateCriteria": "(*:* -keytype:Article -keytype:Media) OR (displaystartdate:[* TO \"2018-02-14T10:49:19Z\"] AND displayenddate:{\"2018-02-14T10:49:19Z\" TO *})"
        }
    },
    "success": true
}

Example Request - Limited Properties

In this request we just want the count of results.

client.invoke("icmapi", "CSSearchMultiple_get", {
    "set": {
        "CollectionNameList": "Article",
        "LuceneRepositoryPath": "http://localhost:5506/solrsite",
        "Keywords": "Tim"
    },
    "get": "SolrResultCount"
});

Example Response - Limited Properties

Note how the CSSearchItem details aren't returned when we define properties in the get request.

"result": {
    "data": {
        "multipleItemData": [{
            "_ItemClass": "CSSearchItem"
        }, {
            "_ItemClass": "CSSearchItem"
        }],
        "itemData": {
            "_ItemClass": "CSSearchMultiple",
            "SolrResultCount": 2
        }
    },
    "success": true
}

Date Faceting

You can perform faceting using the get method. The facets will be present in the DateFacets property of the returned itemData.

Note that this method creates facets for the returned results. The results themselves are not filtered or restricted in any way. To apply facets a subsequent request would have to be made, generally adding the facet as a filter query.

For more examples of faceting, see the knowledge base section of this site.

DateMathParser Syntax

Dates can be passed to SOLR in an ISO 8601 format, "2016-06-01T00:00:00Z", or using DateMathParser (opens new window). This syntax lets you set times in the past (-) or future (+) and round (/) to the start of the current unit.

Common strings include:

NOW - The date and time right now
/MONTH - The start of the current month
+1DAY - One day in the future from now
-1YEAR - One year ago from now

Request Parameters

By default only 10 facets are returned. Set MaxFacets to return a different number.

Example Request

This is the same request as above, but with month facets configured between the start of 2016 and now.

client.invoke("icmapi", "CSSearchMultiple_get", {
    "set": {
        "CollectionNameList": "Article",
        "LuceneRepositoryPath": "http://localhost:5506/solricm",
        "Keywords": "Tim",
        "FacetDates": ["creationdate"],
        "FacetDateStart": "2016-01-01T00:00:00Z",
        "FacetDateEnd": "NOW",
        "FacetDateGap": "+1MONTH",
    },
    "get": "SolrResultCount,DateFacets"
});

Response Properties

Example Response

Three results have been found, falling into two months.

"result": {
    "data": {
        "multipleItemData": [{
            "_ItemClass": "CSSearchItem"
        }, {
            "_ItemClass": "CSSearchItem"
        }, {
            "_ItemClass": "CSSearchItem"
        }],
        "itemData": {
            "_ItemClass": "CSSearchMultiple",
            "SolrResultCount": 3,
            "DateFacets": {
                "creationdate": {
                    "2017-01-01T00:00:00Z": 1,
                    "2018-02-01T00:00:00Z": 2
                }
            }
        }
    },
    "success": true
}

Field Faceting

Field facets work in a broadly similar way to date facets, faceting on a property of the returned CSSearchItems, not just the date fields. As with Date Facets, any configured facets are returned in the FieldFacets property of the returned itemData.

Request Parameters

By default only 10 facets are returned. Set MaxFacets to return a different number.

Example Request

In this example the dynamic OBJECT_RAWC_ field is being used as a facet. This special field is used to preserve the article title which would otherwise have each word broken down into individual tokens.

client.invoke("icmapi", "CSSearchMultiple_get", {
    "set": {
        "CollectionNameList": "Article",
        "LuceneRepositoryPath": "http://localhost:5506/solricm",
        "Keywords": "Tim",
        "FacetFields": ["OBJECT_RAWC__title"]
    },
    "get": "SolrResultCount,FieldFacets"
});

Example Response

Faceting by title probably isn't the best thing to do, as most article titles will be fairly unique. Including "FacetFieldPrefix": "l" with the request would mean only the "latest news" and "locations" facets would be created (all three results would still be returned).

"result": {
    "data": {
        "multipleItemData": [{
            "_ItemClass": "CSSearchItem"
        }, {
            "_ItemClass": "CSSearchItem"
        }, {
            "_ItemClass": "CSSearchItem"
        }],
        "itemData": {
            "_ItemClass": "CSSearchMultiple",
            "FieldFacets": {
                "OBJECT_RAWC__title": {
                    "latest news": 1,
                    "tim's article": 1,
                    "locations": 1
                }
            },
            "SolrResultCount": 3
        }
    },
    "success": true
}

Properties