How to make my own Qualifier work in WDK?

Hi, all.

I want to define my own qualifier for WDK application. The qualifier can use as the following:

<?xml version="1.0" encoding="UTF-8" standalone="no"?>
<config version="1.0">
 <scope myqualifier="myqualifiervalue">
 <!-- Any configuration -->
 </scope>
 <scope>
 <filter myqualifier="myqualifiervalue>
 <!-- Any configuration -->
 </filter>
 </scope>
</config>

Best regards.

Zhou

Find more posts tagged with

Comments

DCTM_Guru

Not sure you can do this without changing the WDK configuration engine. Changing this would probably cause problems when you perform an upgrade, since the framework does NOT officially support custom scoping.

Can you describe what you are trying to do that you cant accomplished with OOTB scope methods?

shailshah

We have created and successfully used a custom qualifier in 5.3 and successfully upgraded it to 6.5 (still in progress). I believe it provides a very elegant way to customize webtop in comparison to other not so pretty and extensible options. This should be a supported change - when we implemented this 3 years ago, we did not find any documentation stating otherwise.

The process involves a few steps:

1. Create a custom qualifier class. Sample class below:

2. Inlcude/register the qualifier class in app.xml so that webtop/wdk is aware of it.

<qualifiers>
             
              <qualifier>com.****.****.web.formext.config.MyQualifier</qualifier>

...

</qualifiers>

3. modify doclist, search results and other necessary JSPs/classes to include the custom attribute on which you want to scope. this is important. You do not want to perform a getObject() or DQL query within the qualifier class code. Since the qualifier is invoked for each item listed, it can be very expensive call and with moderate to heavy user volume, webtop can crawl. Pass the custom attribute value retrieved from the resultset to context by including it in <dmf:actioncheckbox) (sample below)

4. Modify your component XMLs to use the custom qualifier as you described.

that should do it. As you can see, there is quite a bit of effort to make it work, but once everything is in place, the benefits are immense.

Code to create custom qualifier

public class MyQualifier implements IQualifier {

     /* (non-Javadoc)
      * @see com.documentum.web.formext.config.IQualifier#getAliasScopeValues(java.lang.String)
      */
     public String[] getAliasScopeValues(String arg0) {
         return null; //optional
     }

    /* (non-Javadoc)
      * @see com.documentum.web.formext.config.IQualifier#getContextNames()
      */
     public String[] getContextNames() {
            return (new String[] {
                    "objectId",
                    "file_type" //Custom Attribute or value you want to scope by
                });
             }

     /* (non-Javadoc)
      * @see com.documentum.web.formext.config.IQualifier#getParentScopeValue(java.lang.String)
      */
     public String getParentScopeValue(String arg0) {
         return null; //optional
     }

     /* (non-Javadoc)
      * @see com.documentum.web.formext.config.IQualifier#getScopeName()
      */
     public String getScopeName() {
          return "myqualifier"; //name you would use in XML
        }

    /* (non-Javadoc)
      * @see com.documentum.web.formext.config.IQualifier#getScopeValue(com.documentum.web.formext.config.QualifierContext)
      */
     public String getScopeValue(QualifierContext context) {
         String strObjectId,xxxx;

         //get it from context first
         xxxx = context.get("attr_name"); // get teh value using some logic
             if(xxxx != null && xxxx.length()>0)
             {
                 return xxxx;
             }

//if not avialable in context, read it from dcobase,

            // **this can be very expensive, do not query docbase unless absolutely necessary**
         }
         return xxxx;
     }
}

code to include qualifier in JSP, see the last arg:

<dmf:datagridRowTd height="24" nowrap="true" cssclass="doclistcheckbox">

<dmfx:actionmultiselectcheckbox name='check' value='false' cssclass='actions'>
<dmf:argument name='objectId' datafield='r_object_id'/>
<dmf:argument name='type' datafield='r_object_type'/>
<dmf:argument name='lockOwner' datafield='r_lock_owner'/>
<dmfx:argument name='folderId' contextvalue='objectId'/>
<dmfx:argument name='folderPath' contextvalue='folderPath'/>
<dmf:argument name='ownerName' datafield='owner_name'/>
...

<dmf:argument name='topicStatus' datafield='topic_status'/>
<dmf:argument name='myattr' datafield='myattr'/>
</dmfx:actionmultiselectcheckbox>

DCTM_Guru

So if you done this before in 5.3, are you asking how to do it in 6.5? I'm guessing your code doesnt work in 6.5 -> this is exactly what I was referring to about upgrades.

shailshah

Johnny,

I was just responding to the original poster with sample code as to how to write a custom qualifier. We created a custom qualifier in 5.3 and have successfully upgraded to 6.5 and the qualifier still works. We havent completed all the testing yet, but the qualifier code seems to be working just fine in 6.5 without any changes. Unless I missed something, I didnt see anything in the migration/upgrade guide that indicated that custom qualifiers are no longer supported or will break. Have you read/encountered something that suggests otherwise?

DCTM_Guru

My apologies, I thought shailshah was the original poster. Hence my confusion about your post. After seeing your post stating that this works in 6.5 and that WDK guide talks about it, I retract my original post.

shailshah

That is what i thought, Johnny. No worries. You're probably spending more time on these forums that you should Your contribution is always appreciated.