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

Did anyone use GetFileComments() yet?

tobias

Hi there,
this is with TS 6.7.2 on Solaris 10.

Has anyone successfully used the WFtask.pm's GetFileComments() function?
I am currently developing a workflow that contains an externaltask (Perl) which needs to access the comments of each file attached to the workflow.
The .ipl code looks like this:

...
foreach my $file (@files) {
        my @fileCommentList;
        $task->GetFileComments(\@fileCommentList, $file);
        ... now do something with the comment ...
}
...

My @files array is filled (a print() statement shows the correct workarea-relative file paths), and when I use the GUI to check the comments of the particular files of the task I can see the comments just fine. However, in the scripts the @fileCommentList array is empty after the GetFileComments() call.

Any ideas will be appreciated.

Find more posts tagged with

Comments

Adam Stoller

Hi there,
this is with TS 6.7.2 on Solaris 10.
[...]
...
foreach my $file (@files) {
        my @fileCommentList;
        $task->GetFileComments(\@fileCommentList, $file);
        ... now do something with the comment ...
}
...
[...]in the scripts the @fileCommentList array is empty after the GetFileComments() call.

Any ideas will be appreciated.

Are you sure it's empty - or are you assuming that it contains string text and not finding any? The array should be filled with hash-refs - such that

$fileCommentList[0]->{body}

should contain the body of the first comment associated with that file in the current workflow (note, there is an assumption here that there is at least one comment associated with the file, and further, that $task is a valid TeamSite::WFtask object)

tobias

Hey fish,
thanks for the reply. As I wrote: in the GUI I can see that on that particular workflow/task/file a comment is set. (I already set the comments in the .wft template, when I attach the files to the workflow.)
Also, in my program I am using exactly the command you suggest

my $commentBody = $fileCommentList[0]->{body}

to access the first file comment. However, this yields nothing. When I print the $commentBody into my log file, it is empty, and even when I print a ref($commentBody) this is empty.

jbonifaci

That's because GetFileComments() expects a reference to an array from a call to TeamSite::WFutils::find_element_list(). It doesn't look like this is really a supported method any longer.

If I were you, I would use GetFilesAndComments()


use strict;
use TeamSite::WFtask;

my $taskObject = new TeamSite::WFtask(<taskId>);

my %taskFilesAndComments = ();
$taskObject->GetFilesAndComments(\%taskFilesAndComments);

foreach my $taskFile (keys %taskFilesAndComments)
{
 print " FILE: $taskFile\n";

 foreach my $commentHashRef (@{$taskFilesAndComments{$taskFile}})
 {
  print "  COMMENT BODY: $$commentHashRef{body}\n";
 }
}

~Jeff

Adam Stoller

That's because GetFileComments() expects a reference to an array from a call to TeamSite::WFutils::find_element_list(). It doesn't look like this is really a supported method any longer.

If I were you, I would use GetFilesAndComments()

Jeff,
The original code that was posted, shows a reference to an array being passed into GetFileComments() - I'm assuming that was accurately depicted code.

What makes you think that GetFileComments() is no longer a supported method - and that GetFilesAndComments() would be any better?

I'm looking at a 6.x version of the module - and GetFilesAndComments actually loops through the files calling GetFileComments - so while I agree that using GetFilesAndComments is probably a more efficient way to go, that doesn't explain why GetFileComments doesn't appear to be working for this person in this case.

jbonifaci

Jeff,
The original code that was posted, shows a reference to an array being passed into GetFileComments() - I'm assuming that was accurately depicted code.

What makes you think that GetFileComments() is no longer a supported method - and that GetFilesAndComments() would be any better?

I'm looking at a 6.x version of the module - and GetFilesAndComments actually loops through the files calling GetFileComments - so while I agree that using GetFilesAndComments is probably a more efficient way to go, that doesn't explain why GetFileComments doesn't appear to be working for this person in this case.

Hey Adam,

I guess I should have been a little more clear. The $felement that is required for GetFileComments(\@list, $felement) is not a string or integer, but is a reference to an array that is returned in an array of array refs by making a call to TeamSite::WFutils::find_element_list().

I hacked out some of the code from the module and was able to mimic what GetFilesAndComments is doing when it calls GetFileComments and as I said, it works perfectly when you pass in this array ref. Therefore, being that you need to pass in something returned from an undocumented module, I would assume that it really isn't supported any more.

You could probably incorporate the code I did to reproduce the array, but by then, you'd already have the comments and wouldn't need to call GetFileComments. The $felement array ref that is passed to GetFileComments from GetFileAndComments breaks down to something like this:

ARG[0]: Hash Ref
 {deleted}: f
 {path}: <area path to file>
 {objid}: <some hex value>
ARG[1]: String
 'comments'
ARG[0]: Array Ref
 ARG[0]: Hash Ref
  <empty hash>
 ARG[1]: String
  'comment'
 ARG[2]: Array Ref
  ARG[0]: Hash Ref
   {date}: <date in seconds when the comment was made>
   {task}: <task id where the comment was made>
   {user}: <my user id>
  ARG[1]: String
   '0'
  ARG[2]: String
   <first file comment made>
 ARG[3]: String
  'comment'
 ARG[4]: Array Ref
  ARG[0]: Hash Ref
    {date}: <date in seconds when the comment was made>
   {task}: <task id where the comment was made>
   {user}: <my user id>
  ARG[1]: String
   '0'
   ARG[2]: String
   <second file comment made>

So, as you can see, GetFileComments doesn't actually retrieve the comments, it just parses them out of that array and returns them in a more user friendly way. So it seems GetFilesAndComments is the way to go if you want file comments.

Hope that clears things up.

~Jeff

Adam Stoller

Ah - okay now I see what you're talking about:[indent]GetFileComments(\@list, $felement)[indent]Gets the file comments for the task. The result is an array of hash refs, where each hash has keys of ’date’, ’task’, ’user’, and ’body’.[/indent][/indent]$felement is not defined in terms of its function / type in the POD - and the assumption that it is the area-relative-path of a file for which you want to get comments is, apparently, incorrect.
Whereas:[indent]GetFilesAndComments(\%f_and_c)[indent]Returns undef, or an empty array in an error condition.

Files and comments are passed back via the first parameter to this method, with file names as hash keys and values being references to an array of hash refs (see GetFileComments).[/indent][/indent] this only expects a hash reference as a parameter, and takes care of filling it in utilizing GetFileComments with its internal $felement piece.

Besides that - it does make the original calling code a bit cleaner (IMO) since one call gives you the hash reference, and you can sort through the keys of that element easily in a loop and then dereference the information from there.