Programatically Modifying Saved Searches

Hello everyone,

I'm looking for a way to modify saved seraches. Specifically, we are changing a folder name and I would like to search for any saved search that uses that folder, and if possible update it to the new folder.

I've looked at the dm_smart_list object, but the only thing the "selected sources" seems to contain is the docbase, not the cabinet or folder. I also thought it might be on a dm_query, but there doesnt' seem to be one for the saved search I've created.

Does anyone know how to get at, and hopefully modify the folder information?

Find more posts tagged with

Note:

If there are Accepted Answers, those will be shown by default. You can switch to 'All Replies' by selecting the tab below.

Accepted answers

mbrette

I updated my previous post with a fix (change highlighted in bold).

It is surprising that you did not have a ClassCastException when you ran the first version.

Which version of java are you using ?

All comments

mbrette

There is no way to search for it. You will have to retrieve all the smart lists, load them one by one and transform the one that has the folder constraint.

How many smartlist do you have ? It is probably an acceptable approach.

Girevik

I've not run a count yet on the number of smart_lists we have in our docbase.

Are you saying that this would have to be done in the UI? That each saved serach would need to be opened manually, checked for the folder, and changed if necessary?

mbrette

No there is an API for it. But if you have 50000 smartlist, loading each of them will take a while.

I'll post an example soon.

Administrator.ServerConfigurator.log

setupError.log

install.log

mbrette

OK, here is the code. A bit long I'm afraid because we have no simple way to modify the folder, so I ended up copying every piece of the original query.

I did'nt test the code, so you may want to try out on a test docbase first.

package com.documentum.test.fc.client.search.utils;

import com.documentum.com.DfClientX;

import com.documentum.fc.client.*;

import com.documentum.fc.client.search.*;

import com.documentum.fc.common.DfException;

import com.documentum.fc.common.DfLoginInfo;

import java.io.IOException;

public class LoadSmartList

{

private IDfSearchService searchService;

private IDfClient client;

private String docbase;

private String user;

private String password;

private IDfSessionManager sessionManager;

public static void main (String[] args) throws DfException, IOException

{

new LoadSmartList("docbase", "user", "password").transformSmartList();

}

public LoadSmartList (String docbase, String user, String password) throws DfException

{

this.docbase = docbase;

this.user = user;

this.password = password;

DfClientX clientx = new DfClientX();

client = clientx.getLocalClient();

setupSessionManager();

searchService = client.newSearchService(sessionManager, docbase);

}

private void setupSessionManager () throws DfServiceException

{

sessionManager = client.newSessionManager();

sessionManager.setIdentity(docbase, new DfLoginInfo(user, password));

}

public void transformSmartList () throws DfException, IOException

{

IDfSearchStoreService service =

(IDfSearchStoreService) client.newModule(docbase, IDfSearchStoreService.class.getName(), sessionManager);

IDfCollection searchesCollection = service.getAllSearches();

while (searchesCollection.next())

{

String id = searchesCollection.getString("r_object_id");

IDfSmartList smartList = service.loadSearch(id);

migrate(smartList);

}

private void migrate (IDfSmartList smartList) throws DfException, IOException

{

IDfSmartListDefinition definition = smartList.getSmartListDefinition(searchService);

IDfQueryBuilder queryBuilder = (IDfQueryBuilder) definition.getQueryDefinition();

if (needMigration(queryBuilder))

{

definition.setQueryDefinition(transform(queryBuilder));

smartList.save();

}

private IDfQueryDefinition transform (IDfQueryBuilder queryBuilder) throws DfException

{

IDfQueryBuilder newQueryBuilder = searchService.newQueryMgr().newQueryBuilder();

newQueryBuilder.setDateFormat(queryBuilder.getDateFormat());

newQueryBuilder.setDatabaseSearchRequested(queryBuilder.isDatabaseSearchRequested());

newQueryBuilder.setIncludeAllVersions(queryBuilder.isIncludeAllVersions());

newQueryBuilder.setIncludeHiddenObjects(queryBuilder.isIncludeHiddenObjects());

newQueryBuilder.setObjectType(queryBuilder.getObjectType());

newQueryBuilder.setRootExpressionSet(queryBuilder.getRootExpressionSet());

IDfEnumeration attributes = queryBuilder.getResultAttributes();

while (attributes.hasMoreElements())

{

newQueryBuilder.addResultAttribute((String) attributes.nextElement());

}

IDfEnumeration sources = queryBuilder.getSelectedSources();

while (sources.hasMoreElements())

{

IDfSearchSource source = (IDfSearchSource) sources.nextElement();

newQueryBuilder.addSelectedSource(source.getName());

}

IDfEnumeration scopes = queryBuilder.getScopes();

while (scopes.hasMoreElements())

{

IDfQueryScope scope = (IDfQueryScope) scopes.nextElement();

addTransformedScope(newQueryBuilder, scope);

}

if (queryBuilder.getMaxResultCount() >= 0)

newQueryBuilder.setMaxResultCount(queryBuilder.getMaxResultCount());

if (queryBuilder.getMaxResultPerSource() >= 0)

newQueryBuilder.setMaxResultPerSource(queryBuilder.getMaxResultPerSource());

return newQueryBuilder;

}

private void addTransformedScope (IDfQueryBuilder newQueryBuilder, IDfQueryScope scope)

throws DfException, DfUnreachableLocationException

{

if (scope.getScopeType() == IDfQueryScope.SCOPE_LOCATION)

{

IDfLocationQueryScope location = (IDfLocationQueryScope) scope;

newQueryBuilder.addLocationScope(

location.getSource(), transformFolderName(location.getLocationPath().getFullPath()),

location.isDescend(), location.isExcluded());

}

else

{

throw new RuntimeException("Unexpected scope:" + scope);

}

private boolean needMigration (IDfQueryBuilder queryBuilder) throws DfException

{

IDfEnumeration scopes = queryBuilder.getScopes();

while (scopes.hasMoreElements())

{

IDfQueryScope scope = (IDfQueryScope) scopes.nextElement();

if (scope.getScopeType() == IDfQueryScope.SCOPE_LOCATION)

{

IDfLocationQueryScope location = (IDfLocationQueryScope) scope;

IDfObjectPath path = location.getLocationPath();

String fullPath = path.getAccessiblePath();

if (containOldPath(fullPath))

return true;

}

return false;

}

private String transformFolderName (String fullPath)

{

return fullPath.replace("OldPathName", "NewPathName");

}

private boolean containOldPath (String fullPath)

{

return fullPath.contains("OldPathName");

}

Girevik

Awseome, I'll take a look and see if that works for me. Thanks!

Girevik

It ALMOST works (pretty impressive for not having tested). The only issue is that after the conversion, in addtion to all the original search sources, there is also an entry for "com.documentum.fc.client.search.impl.definition.metadata.DFSearchSource". I only see this in the Webtop UI....it doesn't show as scope path on the object. When I try to run the search, I get a message that this source is not available.

I've tried to compare before and after snapshots, but so far I've not been able to track down what is causing this.

mbrette

I updated my previous post with a fix (change highlighted in bold).

It is surprising that you did not have a ClassCastException when you ran the first version.

Which version of java are you using ?

Girevik

Initial pass, it looks like that has it.

I did get an execption on that cast initially, so I just changed it to a .toString(). Looks like I was a bit too simplistic.

Thanks again for your help. I had started down that road a little bit, but it would have taken me a good while to figure all that out.