nav[aria-label="Primary Navigation"] { padding: 0; & ul { list-style: none; width: 100%; display: flex; flex-direction: row; justify-content: start; align-items: start; gap: 30px; padding: 0; & li { margin: 0; } & ul li { list-style: none; } } }

WSW Custom Menus: Object Attributes

Rooose

Hi,

I've added some custom menus to Worksite Web. One of the menu options requires the custom2 (matter code) of the object which the menu option is selected for.

Is there any easy method of retrieving custom2 or any other attribute assigned on the object (Workspace or Document)

many thanks
RW

Find more posts tagged with

Comments

jny

I'm not familiar with the WSW menu. But, if you have a handle to the IManDocument or IManWorkspace Object, you should be able to call the GetAttributeByID Method off of the object to return the specified custom attribute. The argument you would pass into the method should be intellisensed thus revealing a list of attriburteID Enum. For example, this code will return the custom2 alias off of a workspace and document:

[VBNET]
==========================================
'Assuming ws is a handle to a valid workspace object
Dim wsCust2 As IManCustomAttribute = ws.GetAttributeByID(imProfileAttributeID.imProfileCustom2)
Dim wsCust2Alias As String = wsCust2.Name

'Assuming doc is a handle to a valid document object
Dim docCust2 As IManCustomAttribute = doc.GetAttributeByID(imProfileAttributeID.imProfileCustom2)
Dim docCust2Alias As String = docCust2.Name
==========================================

Rooose

Thanks for your reply jny.

Unfortunatley, I don't think there is access to an object ant the point the menu option is selected.

All i seem to have available is an ObjectID (moniker) and other limited properties shown within the "Params" function within clientMenus.js

jny

If you have the moniker, you should be able to get a handle to the actual object by calling the IManDMS.GetObjectBySID(objectID) Method. Of course, you would need to first either get a hold of the current session or logon to your own.

There might be a more efficient way to accomplish this, but I'll leave that up to the WSW folks to review it.

dabird

Rooose,

I need some more information before I can point you in the right direction.

Do you need access to the custom2 value *before* building your custom menu item (i.e. you require the value to show the menu), or do you need the custom2 value when you go to your menu handler (i.e. you need the value to complete the menu operation)? Is your menu handler a client-side JavaScript function or are you going to a server-side handler?

Based on your responses, I can point you to either (a) making an AJAX request or (b) server-side processing.

Regards,
dabird

P.S. Also need the version of WSW in which you are working.

Rooose

Hi dabird,

I need access to custom2 value when the menu item is selected (so that i can pass it to my app). My menu handler is client-side javaScript. Running on WSW 8.2.22

thanks,
RW

dabird

Rooose,

To get a handle to custom2 for your menu processing, you'll need to customize the menu parameters that are sent to the client-side as properties of "pObj". The menu parameters are built on the server-side using a class called MenuParameters. You'll have to contact TechSupport to request the source code for MenuParameters. They'll have you sign an NDA form and then I can give you steps from there. NOTE: Your code change will be quite simple once you get the source code.

The other option you have is to write a server-side http handler that takes the document moniker as a parameter, gets the IManDocument object and then redirects to your custom app with the custom2 value from the document. Your JavaScript handler in the menu would send the user to this intermediate page before going to your app outside.

Regards,
dabird

Rooose

Hi dabird,

Sorry its been a while since last contact on this.

I've now got the NDA signed and downloaded the source. Can you give me some indication of what changes are required in order to obtain custom1 & custom2 fields. Also would this change be affected if (our) client ungrades?

many thanks,
RW

dabird

Hi RW,

Inside the source code project, you'll need /scripts/MenuParameters.cs. You will have to create a custom handler, copy the original WSW code and then insert your code. You need the source code because we don't have any hooks inside the menu processing where you can get a handle to the current object and insert additional properties. Once you build your custom handler into an assembly, you'll have to modify the web.config to point to it. When your clients upgrade to a new version of WorkSite Web, you will have to upgrade your customization too. First, your client will most likely uninstall the previous version of WorkSite Web. This will wipe out your entry in the web.config. Second, we might put a bug fix in menu processing, and if you don't upgrade you won't get the fix.

MenuParameters.cs is a server-side handler that builds a client-side JavaScript menu object variable called "pObj". All you have to do is append some custom strings initializing pObj with your c2 values for the client-side. Then, inside your custom menu in clientMenus.js, you just need to look at the value of the property you set.

NOTE: Our code is C#, so that's what I am going to reference in this explanation. You could just as easily port the code to VB.NET.

Create a new C# Class Library project.
Reference iManage.WorkSite.Web.UI.dll, iManage.WorkSite.Web.dll, Interop.iManage.dll and Interop.iManAdmin.dll. All of these are found in <worksite_install_path>/bin.
Inside your new class, replace the pre-generated code with that from /scripts/MenuParameters.cs. Make sure to copy the code in its entirety.
Rename the namespace to your custom namespace, like "iManage.WorkSite.Web.UI.YourCompany.Customizations".
To set c2 for documents, go to process(IManDocument). To set c2 for workspaces, go to process(IManWorkspace).
At the end of these functions, merely append your pObj property using the IManObject:
```
str.AppendFormat(@&pObj.custom2={0}, <IManDocument|IManWorkspace_C2_value>);
```
NOTE: The pObj is sent back as a query string, so you must append "&" in front of "pObj" in your string; otherwise, you'll get a JavaScript error on the client-side.
Save your file and compile your code into a new assembly.
Copy your assembly to <worksite_install_path>/bin directory.
Inside the web.config for WorkSite Web, comment out the original WorkSite Web entry for MenuParameters.
Add an entry in the WorkSite Web web.config pointing to your new MenuParameters handler. This will redirect any requests for "scripts/MenuParameters.aspx" to your custom handler instead of the Worksite handler.
Save the web.config and debug/test as needed.

Do let me know how this goes!

Regards,
dabird