Objective
It can be used when it is necessary to filter the documents retrieved by user or group. Documents will be only retrieved if users or groups have enough permission to access them. Documents without security will not be retrieved by this method. The trustees (user or groups) passed on this method will be used to control if the document can be retrieved or not. For instance, when using a group as “trustee” parameter, the search process can only check the documents ACL’s where the group appears. Other documents where the group members are in the ACL won’t be included in the results. DST must be provided.
It allows the user to select a number of elements in every page and retrieve only the selected page.
Parameters
| Parameter | Description | Type |
| library | eDOCS library | String |
| user | User name | String |
| password | User password | String |
| searchForm | The name of the search form. | String |
| searchCriteria | All of these properties must be passed as a string. Properties have to be separated by xml format.
| String |
| orderByProperties | The same format as “searchCriteria” parameter. 0 forces ascending order and 1 forces descending order. It’s possible to combine ascending and descending order types like in this example: All the properties passed in orderByProperties must be included in the returnProperties field. | String |
| retrieveAll | With “True” value all the properties in the profile are returned addition to all the properties introduced in parameter “returnProperties” if it contains any property. With “False” value only properties written in the “returnProperties” parameter are returned. | String |
| returnProperties | When the value for the “retrieveAll” parameter is “False”, it is mandatory to pass a string with the properties. If any properties have been specified in the “orderByProperties” parameter, they must also be present here. If the value for retrieveAll is “True,” this parameter can be used to include non-profile properties, such as FT_SCORE. | String |
| showTrustees | If “True” is passed, security information is included in the XML. This value should only be set to “True” if really necessary, due to process time consumption. (See Appendix C for more information) | String |
| dbSchema | Database schema. By default is set to “DOCSADM” if an empty string is passed. | String |
| maxRows | Number of rows to return in each page. | Integer |
| trustee | User_ID or Group_ID, such as “ADMINISTRATOR” or “ALL_INTRANET”. It is not the Group_Name or User_Name. | String |
| userOrGroup | “U” to filter by user, or “G”, to filter by group. | String |
| accessRights | The minimum access level that a user or group must have to access the documents. By default, this value is set to 1. (See Appendix B & C for a complete enumeration of access rights values allowed and retrieval performance capabilities) | String |
| index | Number of the page. First page is 0. | Integer |
| rowsLimit | The number of results to be returned. To return all possible results, this parameter should be set to 0. | String |
| client | Optional parameter for the client code | String |
| project | Optional parameter for the project code | String |
Rest Invoke
- http://localhost:port/GSService/xml/ or http://localhost:port/GSService/json/
- UriTemplate:
- “/AdvancedSearchDocumentByTrusteePag/?library={library}&user={user}&password={password}&searchForm={searchForm}&searchCriteria={searchCriteria}&orderByProperties={orderByProperties}&retrieveAll={retrieveAll}&returnProperties={returnProperties}&rowsLimit={rowsLimit}&showTrustees={showTrustees}&dbSchema={dbSchema}&trustee={trustee}&userOrGroup={userOrGroup}&accessRights={accessRights}&index={index}&maxRows={maxRows}&client={client}&project={project}”
- “/AdvancedSearchDocumentByTrusteePagDST/?library={library}&user={user}&dst={dst}&searchForm={searchForm}&searchCriteria={searchCriteria}&orderByProperties={orderByProperties}&retrieveAll={retrieveAll}&returnProperties={returnProperties}&rowsLimit={rowsLimit}&showTrustees={showTrustees}&dbSchema={dbSchema}&trustee={trustee}&userOrGroup={userOrGroup}&accessRights={accessRights}&index={index}&maxRows={maxRows}&client={client}&project={project}”
Example
http://localhost:8732/GSService/xml/AdvancedSearchDocumentByTrusteePag/?library=DMTESTLEGAL&user=admin&password=owc123&searchForm=LAWPROF&searchCriteria=*testpdf*&orderByProperties=01&&retrieveAll=False&returnProperties=&rowsLimit=0&showTrustees=True&dbSchema=DOCSADM&trustee=admin&userOrGroup=U&accessRights=1&index=0&maxRows=10
The method returns a XML file with the profile properties requested as well as information about security permissions and users and groups associated with each document (if “showTrustees” has been sent to “True”).
The previous example call will only return the first 10 elements of the first page.
Note: if the user is member of a group that has access permission to the document, the document will be retrieved as well.
DST Example
http://localhost:8732/GSService/xml/AdvancedSearchDocumentByTrusteeDST/?library=DMTESTLEGAL&user=admin&dst=afd448a5d0f9b...55355b8c677ad16&searchForm=LAWPROF&searchCriteria=*testpdf*&orderByProperties=01&&retrieveAll=False&returnProperties=&rowsLimit=0&showTrustees=True&dbSchema=DOCSADM&trustee=admin&userOrGroup=U&accessRights=1&index=0&maxRows=10
Error
Check the edocs.log file if errors arise in the unlock process.
