AnsweredAssumed Answered

transition comment in API

Question asked by Jeremy Schmidt on May 25, 2010
Latest reply on May 27, 2010 by Jeremy Schmidt

Like • Show 0 Likes0
Comment • 5

Is there a way to capture the transition comment within the API or better yet, without the API? Here is my scenario.

User A sends a document from workflow state 1 to state 2

the user login is stored in the SubmitterEmail variable on the card

User B decides a change needs to be made and send the document back to state 1

my addin runs prestate change and sends an email to User A using the SubmitterEmail variable

SubmitterEmail is then cleared by the transition

I'd like the User B's comments from the transition of state 2 to 1 to be included in the email, but I'm not finding a way to capture this data.

Any suggestions?

Jeff Sweeney May 26, 2010 9:50 PM

Correct Answer

You can get the transition comment through the EdmHistory object.

This snippet shows all transition comments for objFile:

Dim objHistory as IEdmHistory

objHistory = objVault.CreateUtility(EdmUtility.EdmUtil_History)
objHistory.AddFile(objFile.ID)
Dim ppoHistory() As EdmHistoryItem 'this array will hold all transition information
objHistory.GetHistory(ppoHistory, EdmHistoryType.Edmhist_FileState)
For intCounter = 0 To UBound(ppoHistory)
ppoHistory(intCounter).mbsComment 'Comment
Next Counter

See the reply in context

No one else had this question

Outcomes

Jeff Walters May 26, 2010 1:29 PM

Is your transition comment the same as version comment? If so you might want to look at IEdmVersion5.

Actions

Jeremy Schmidt @ Jeff Walters on May 26, 2010 1:35 PM

I am able to get the version comment, but in this scenario, the transition comment is the reason for sending the document back to the previous step, not what changed between versions.

Actions

1-A5CHD1 @ Jeremy Schmidt on May 26, 2010 7:36 PM

Could you query the database directly?

Actions

Jeff Sweeney May 26, 2010 9:50 PM

You can get the transition comment through the EdmHistory object.

This snippet shows all transition comments for objFile:

Dim objHistory as IEdmHistory

Actions

Jeremy Schmidt @ Jeff Sweeney on May 27, 2010 1:04 PM

This was almost exactly what I needed. Thanks so much for the help.

I ended up having to change the hook to poststate, because the last transition comment wasn't available in prestate (which makes sense). I originally had it as prestate since I was removing the SubmitterEmail variable during the same "rejection" transition. I have since switched my code to use the same history object to find the user executing the "submit" transitions and removed the SubmitterEmail variable from the datacard. This works fine, but I am of the belief that it's better to configure than to create custom code. I'd much rather use the standard options (the variables in this case), than code that is looking for specific state names. Do you have any suggestions other than creating another secondary state and automatic transition that would reset the SubmitterEmail variable so I could still get the variable poststate? I hope that makes sense.

Actions

5 Replies

Jeff Walters May 26, 2010 1:29 PM
Mark Correct
Correct Answer
Is your transition comment the same as version comment? If so you might want to look at IEdmVersion5.
Like • Show 0 Likes0
Actions
- Jeremy Schmidt @ Jeff Walters on May 26, 2010 1:35 PM
  Mark Correct
  Correct Answer
  I am able to get the version comment, but in this scenario, the transition comment is the reason for sending the document back to the previous step, not what changed between versions.
  Like • Show 0 Likes0
  Actions
  - 1-A5CHD1 @ Jeremy Schmidt on May 26, 2010 7:36 PM
    Mark Correct
    Correct Answer
    Could you query the database directly?
    Like • Show 0 Likes0
    Actions
Jeff Sweeney May 26, 2010 9:50 PM
Unmark Correct
Correct Answer
You can get the transition comment through the EdmHistory object.

This snippet shows all transition comments for objFile:

Dim objHistory as IEdmHistory
objHistory = objVault.CreateUtility(EdmUtility.EdmUtil_History)
objHistory.AddFile(objFile.ID)
Dim ppoHistory() As EdmHistoryItem 'this array will hold all transition information
objHistory.GetHistory(ppoHistory, EdmHistoryType.Edmhist_FileState)
For intCounter = 0 To UBound(ppoHistory)
ppoHistory(intCounter).mbsComment 'Comment
Next Counter
Like • Show 0 Likes0
Actions
- Jeremy Schmidt @ Jeff Sweeney on May 27, 2010 1:04 PM
  Mark Correct
  Correct Answer
  This was almost exactly what I needed. Thanks so much for the help.
  
  I ended up having to change the hook to poststate, because the last transition comment wasn't available in prestate (which makes sense). I originally had it as prestate since I was removing the SubmitterEmail variable during the same "rejection" transition. I have since switched my code to use the same history object to find the user executing the "submit" transitions and removed the SubmitterEmail variable from the datacard. This works fine, but I am of the belief that it's better to configure than to create custom code. I'd much rather use the standard options (the variables in this case), than code that is looking for specific state names. Do you have any suggestions other than creating another secondary state and automatic transition that would reset the SubmitterEmail variable so I could still get the variable poststate? I hope that makes sense.
  Like • Show 0 Likes0
  Actions

transition comment in API

Outcomes

Related Content

Recommended Content