CMS_API_SEARCH

functionality description filenet notes documentum notes box notes m365/sharepoint notes iv cmsprofile required determines which configured cms profile in link enterprise sap to utilize combination of cms profile and cms tag determine the api destination and thus load across an rfc destination iv cmstag required determine which configured cms profile in link enterprise sap to utilize combination of cms profile and cms tag determine the api destination and thus load across an rfc destination iv repository required determines which configured repository in link enterprise sap to utilize object store docbase default is the only store/repository supported since box currently doesn’t support the notion of different repositories site, site collection iv type optional what cms type to create document class defaults to the searching “document” document class if unspecified if “include subfolders” configuration is enabled on connector it will also include all sub classes of the document class object type defaults to the searching “dm document” class and all sub types if unspecified metadat template includes all documents with or without metadata templates if empty content type defaults to searching a document of content type document if not specified iv use mapping optional use mapping of iv type to cms type in enterprise connector if cms used if archivelink doctype name to cms type mapping is required iv where allows for adding additional search criteria with the search with box if used it is the only thing that can be specified while searching refer to the “relational queries” section from the online filenet p8 info center documentation for help with constructing advanced where clauses examples documenttitle = ‘test tif” \<property name> is null datecreated > 20160801t080000z datecreated > 2016 08 01t12 00 00 08 00 refer to the documentum dql reference material for more information on constructing advanced where clauses examples \<property name> is null r modifer <> '\<username>' \<property name> is not null r modify date > date('08/01/2016') refer to the box api for the search api call for what can be used as the where clause examples mdfilters=\[{"templatekey” ”\<template name>","scope" "enterprise","filters" {“\<metadata name>" "true"}}]\&limit=50\&offset=0 refer to the graph api for the search api call for what can be used as the where clause examples mdfilters=\[{"templatekey” ”\<template name>","scope" "enterprise","filters" {“\<metadata name>" "true"}}]\&limit=50\&offset=0 iv location limit the search results to the specified location relative folder names are used with / being the root currently unfiled documents cannot be searched from the profile wizard utilities relative cabinet/folder names are used with / being the root a number for the exact folder location can be specified relative folder names are used with a / being the root if a root folder is configured for the box cms in the enterprise connector all relative folder locations will be relative to the root folder configured iv max results limits the returned results to the amount specified generally the maximum results by default are around 5000 tests should be made to confirm that the system is configured to return a max of 5000 results though the default max search results is currently unknown tests should be performed to determine if there is a default maximum if it is of concern with a where clause type of query the max results you can get is 200 you may retrieve more with sub folders on the api destination configuration in the connector the default max search results is currently unknown tests should be performed to determine if there is a default maximum if it is of concern iv max time limits the returned results to the time specified iv date time fmt if date/time is specified, what format is it in leave empty for default configured in enterprise connector (recommended) must be mm/dd/yyyy hh\ mm\ ss a z, where a z = the am/pm and timezone example 12/31/9999 12 00 00 pm mst must be mm/dd/yyyy hh\ mm\ ss a z, where a z = the am/pm and timezone example 12/31/9999 12 00 00 pm mst it metadata filter if specified, only metadata properties indicated will be returned by default of no filter is provided, all metadata for a document is retrieved see notes in et metadata id see notes in et metadata id not supported see notes in et metadata id not supported see notes in et metadata id it metadata order allows ordering of search results by the specified properties in the order selected if a single property is passed in the results are ordered in ascending order for the property name if unspecified the results are ordered by “id” optionally you can specify asc or desc after the property name to make the sort happen ascending or descending respectively the property being ordered by must also be specified as one of the selected properties if a single property is passed in the results are ordered in ascending order for the property name if unspecified the results are ordered by “r object id” optionally you can specify asc or desc after the property name to make the sort happen ascending or descending respectively the property being ordered by must also be specified as one of the selected properties not supported not supported et metadata id contains the metadata retrieved if no properties are specified (it metadata filter ) then by default only the below will be returned id documenttitle some properties can’t be returned in searches like contentelements foldersfiledin some key properties that have special handling via search versionseries = will return the version series id classdescription = gets the symbolic name storagearea = gets the display name storagepolicy = gets the policy name securitypolicy = gets the policy name ownerdocument = gets the id of the owner document sourcedocument = gets the id of the source document replicationgroup = gets the display name of it securityfolder = gets the folder path name publishingsubsidiaryfolder = gets the folder path name if no properties are specified (it metadata filter ) then by default only the below will be returned r object id title some properties can’t be returned in searches like contentelements foldersfiledin versionseries if no metadata is specified (it metadata filter – currently not supported by box api endpoint) then by default only the below will be returned id name if no metadata is specified (it metadata filter – currently not supported by graph api endpoint) then by default only the below will be returned id object name object et return table that indicates a success of an error the type field will contain an ‘s’ or ‘e’ respectively and the message field will contain information in the case of an error ct custom future use general comments behind the scenes at the connector level, the search uses either a select or a where clause what determines this from the sap side is the usage of the iv where parameter vs not (in tern uses a select) general filenet comments if not using paged search results and if the number of results exceeds the content caches default max search results you will only get that many results and you won’t be able to see the other results generally this is around 5,000 results using the profile wizard search utility screen as an example the generated sql behind the scenes (if “include subfolders” is selected) select top \<max results> \<select clause> from \<from clause> with includesubclasses where \<where clause> and \<from clause> this insubfolder ‘\<location>’ order by \<order by clause> using the profile wizard search utility screen as an example the generated sql behind the scenes (if “include subfolder” isn’t selected) select top \<max results> \<select clause> from \<from clause> where \<where clause> and \<from clause> this infolder ‘\<location>’ order by \<order by clause> refer to the relational queries section on the ibm infocenter documentation for filenet p8 for help with configuring advanced where clauses http //www ibm com/support/knowledgecenter/ssnw2f 5 2 1/com ibm p8 ce dev ce doc/query sql syntax rel queries htm?cp=ssnw2f 5 2 1%2f10 2 1 34 4 1\&lang=en http //www ibm com/support/knowledgecenter/ssnw2f 5 2 1/com ibm p8 ce dev ce doc/query sql syntax rel queries htm?cp=ssnw2f 5 2 1%2f10 2 1 34 4 1\&lang=en general documentum comments if not using paged search results and the number of results exceeds the default max search results you will only get that many results and you won’t be able to see the other results using the profile wizard search utility screen as an example the generated sql behind the scenes (if “include subfolders” is selected) select \<select clause> from public \<from clause> where \<where clause> and folder (‘\<location>’,descend) order by \<order by clause> enable (return top \<max results>) using the profile wizard search utility screen as an example the generated sql behind the scenes (if “include subfolder” isn’t selected) select \<select clause> from public \<from clause> where \<where clause> and folder (‘\<location>’) order by \<order by clause> enable (return top \<max results>) refer to the documentum dql reference manual for help with configuring advanced where clauses general box comments currently paged search results are only supported when using a where clause if using the where clause the max search results can be a maximum of 200 if using the select clause the max search results is 1000 per folder adjusting the metadata templates requires restarting the link enterprise services and profile wizard for the changes to be visible updated metadata can take upwards of 10 minutes before a search using a where clause will find it locations can be specified either using the exact folder number or via a relative path with / being the root if the location is specified via a relative path the folder names can take upwards of 10 minutes before a search using a relative path in the location field will find it searches can either be performed by using a where clause (and nothing else) or by using a select clause and optional location and optional max results when searching via select clause (instead of a where clause) there is a performance hit when searching with a specified from clause since documents are just listed out by folders and specifying metadata template information to query requires each document to be read from a folder listing use searches with a select clause and from clause sparingly if possible in those cases using a where clause search is advisable refer to the box content api for the search api call for help in configuring advanced searches using the where clause https //docs box com/reference#searching for content https //docs box com/reference#searching for content