IBM® CMIS for Content Manager allows CMIS client applications to scope or limit a query to a folder and its descendant documents and subfolders by using the CMIS query function, IN_TREE().
Use this parameter to query with the IN_TREE predicate. In CMIS specifications, the IN_TREE predicate function allows users to restrict the query results to be objects under a given folder object, identified by the input. For example:
SELECT * FROM cmis:document WHERE IN_TREE('myRootFolderId')Because Content Manager EE does not inherently support this feature, the IBM CMIS for Content Manager implementation is a SQL user-defined function (UDF) that is defined in your database and is created during your IBM CMIS for Content Manager configuration, in your Content Manager EE library server database.
Set this flag to UDF to allow CMIS queries with IN_TREE predicate. The performance of this UDF depends on the number of objects in your system and the number of levels of folders. When this flag is set to UDF, you must set another flag, searchInTreeLevelsInitialSetupUDF, to a positive integer.
The IBM CMIS for Content Manager configuration tool creates the UDF in the Content Manager EE library server when this flag is set to UDF.
You must run the IBM CMIS for Content Manager configuration tool again to change the value of searchInTree parameter or the searchInTreeLevelsInitialSetupUDF parameter. The IN_TREE UDF is created again with the maximum levels of recursion that is specified by searchInTreeLevelsInitialSetupUDF parameter.
For IBM Content Manager for z/OS®, the UDF setting is supported only on DB2® for z/OS Version 10 or above. To use this parameter, you must install or migrate to DB2 Version 10 for IBM Content Manager for z/OS Then, you must apply the following APAR to DB2 for z/OS:
The configuration tool returns an error message, feature not implemented, when the DB2 for z/OS version is older than Version 10.
If you decide not to set the IN_TREE function because of performance or other issues, you can set the flag to either ERROR or IGNORE.
Set to ERROR if you want the calling application or user to know that IN_TREE predicate is not supported. An error message is returned to the user explaining that the feature to scope results to a folder tree is not supported. The UDF is not created during configuration.
Set to IGNORE if you want minimal disruption to existing CMIS applications that might have coded by using the IN_TREE predicate. In this case, the entire IN_TREE predicate is ignored in the query and query results are returned according to the rest of the query conditions. You do not get any error messages. The UDF is not created during configuration.