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; } } }

XML schema for rules engine event data

StuartM

Hello People,

My first post. Can anyone tell a newbie where to find the XML schema for the rules engine event data?

Thanks,

Stu

Find more posts tagged with

Comments

jny

Could you explain in more details as to what you're trying to accomplish? Are you trying to add rules to a folder so that the rules engine will kick in to fire e-mail notification when a certain event occurs on the specified folder? Or something else? Also, which version of the WorkSite SDK are you using? And, is this for your own independent app or customization on top of a WorkSite Client?

wolfgang

Hi!

[...] Are you trying to add rules to a folder so that the rules engine will kick in to fire e-mail notification when a certain event occurs on the specified folder? [...]

... which is what I am currently trying to achieve, but have not yet found any clue in the documentations about.

My intuition tells me, if I wanted to add a rule to a folder in order to fire an e-mail when a document is filed into it, I would have to look in the properties of that folder. But the properties dialog does not have any option about rules, neither in FileSite nor in DeskSite.

Does anybody know where I should look?

Regards,
Wolfgang

dabird

Rules Engine, and the schema associated with the rules, is used by WorkSite Web. I don't believe that DeskSite and FileSite support this feature. Additionally, the schema is only meant for internal WorkSite Web consumption, so we don't provide it as a "readable" file in the WorkSite Web directory. You can view the schema using Reflector. Open the iManage.WorkSite.Web.dll and go to the Resources folder. The schema is called "immn.xml".

jny

Hi!

... which is what I am currently trying to achieve, but have not yet found any clue in the documentations about.

My intuition tells me, if I wanted to add a rule to a folder in order to fire an e-mail when a document is filed into it, I would have to look in the properties of that folder. But the properties dialog does not have any option about rules, neither in FileSite nor in DeskSite.

Does anybody know where I should look?

Regards,
Wolfgang

If you already have WorkSite Rules Engine established, then you may add a folder rule to fire off an e-mail notification on a specified op, i.e., delete document, create document, modify profile, etc. The code example below demonstrates how to create a folder, add a rule, and a rule event type to the folder.

Please note that the WorkSite Rules Engine currently only supports e-mail notification. The WorkSite Web Client is the only application that has the SMTP implementation to send out the e-mail notification.


Dim pDms As New ManDMS
Dim pSess As IManSession
Dim pDb As IManDatabase
Dim pFolders As IManDocumentFolders
Dim pFolder As IManDocumentFolder
Dim pRuleEventHandler As IManRuleHandler
Dim pRule As IManRule
Dim pEventtypes As IManRuleEventTypes
Dim pEventtype As IManRuleEventType

Dim sRuleActionData As String
'this string is used to store the XML data which represents the rule action data. 

On Error GoTo Oops

Set pSess = pDms.Sessions.Add("")
pSess.TrustedLogin

Set pDb = pSess.PreferredDatabase

' Create a new folder to test rule
Set pFolders = pDb.Root.SubFolders
Set pFolder = pFolders.AddNewDocumentFolder("TestRuleFolder", "Folder created to add rules via the SDK")

' Get rule handler
With pDb
If Not .RuleHandlers Is Nothing Then
If .RuleHandlers.Count > 0 Then
Set pRuleEventHandler = .RuleHandlers.Item(1)   'The RulesEngine supports only one, which is Email Notification.
End If
Else
GoTo Cleanup
End If
End With

' Get event types.  Currently, WorkSite Web supports the following event types for document folders:
'   Add Document to Folder (Import Document)
'   Remove Document (Delete Document)
'   Create Version in Folder (New Document Version)
Set pEventtypes = pDb.RuleEventTypes


' Add a rule to a folder
Set pRule = pFolder.Rules.Add("Import Document", sRuleActionData, pRuleEventHandler, "", pRuleEventHandler.Name)

' Add a rule event type to rule
pRule.RuleEventTypes.Add pEventtypes.Item(8)  ' Item 8 fires an event of Delete Document
' Iterate through collection to find an event type suitable for you.
pRule.Update

' Get event type
Set pEventtype = pRule.RuleEventTypes.Item(1)

' Log folder event
pFolder.LogEvent pEventtype, pRuleEventHandler.Name
pFolder.Update

GoTo Cleanup
Oops:
MsgBox Err.Description
Err.Clear
Resume Next

Cleanup:
If pSess.Connected Then pSess.Logout
pDms.Close
Set pDms = Nothing
Set pSess = Nothing
Set pDb = Nothing
Set pFolders = Nothing
Set pFolder = Nothing
Set pRuleEventHandler = Nothing
Set pRule = Nothing
Set pEventtypes = Nothing
Set pEventtype = Nothing

Note that I've left out the string value that should be assigned to sRuleActionData. This is because the format of the XML data must be built syntactically correct, in accordance with the language you use. An example of the finished, "escaped", format of the XML is in the attached text file.

wolfgang

Thank you, jny, this helps a huge step. I'm sure I'll come back with more detailed questions later, though. :-)

(Scratching my head) One more question arises: How come the Rules Engine is installed along with WorkSite Server, when you actually need to have WorkSiteWeb to use it?

jny

Thank you, jny, this helps a huge step. I'm sure I'll come back with more detailed questions later, though. :-)

(Scratching my head) One more question arises: How come the Rules Engine is installed along with WorkSite Server, when you actually need to have WorkSiteWeb to use it?

The Rules Engine is a software executed on the server-side for those server objects (folders) that have establised with rules, which means it needs to connect with SQL. Via the DMS Service Manager, you can configure the SMTP Server to use for sending notification e-mails as well as how frequent the engine should check for rules' events. The WSW component sends the e-mail notification through SMTP request, which is a client-side operation.

For more details, see the Implementation Guide for WorkSite Server which is distributed with the WorkSite Server installation software.