Notice: In order to edit this ticket you need to be either: a Product Owner, The owner or the reporter of the ticket, or, in case of a Task not yet assigned, a team_member"

User Story #10926 (closed)

Opened 8 years ago

Closed 7 years ago

Handling of companion files in clients and server

Reported by: bpindelski Owned by:
Priority: blocker Milestone: 5.0.1
Component: Services Keywords: fs
Cc: fs@…, web-team@… Story Points: n.a.
Sprint: n.a. Importance: n.a.
Total Remaining Time: n.a. Estimated Remaining Time: n.a.


On dev_4_4 companion files (which are a file annotation) are linked to the image (PixelsOriginalFileMap?). This doesn't happen anymore on develop. The companion file now is linked to the same fileset id as the image being imported. According to Jean-Marie, this will increase the number of calls that the client will need to do to retrieve the companion file (don't confuse with original metadata) - first to get the fileset id from the images, then use that to get the companion file. This problem might also impact analysis or tables files attached to images.


This has to be fixed in 3 places: server, Web and Insight. A decision has to be made how the companion files are retrieved so that the clients aren't blocked with an unnecessary high amount of method calls.

Change History (5)

comment:1 Changed 8 years ago by jamoore

See getUsedFiles(boolean noPixels) If noPixels is set to true, then the files returned from Bio-Formats will not contain pixel data, i.e. companion files. Even these can be quite large in some instances and not something that should/could be shown to users without a special UI.

comment:2 Changed 8 years ago by jamoore

More advanced method to look at: getAdvancedSeriesUsedFiles(boolean noPixels). Should we support companion files per image in the series (i.e. MIF)? If so, this likely means adding "int seriesIndex" and "boolean companion" to the FilesetEntry table for each OriginalFile in the Fileset.

comment:3 Changed 8 years ago by jburel

  • Priority changed from minor to blocker

boosting to blocker, regression

comment:4 Changed 8 years ago by agilo

  • Status changed from new to accepted

Updated status, related task in progress

comment:5 Changed 7 years ago by jamoore

  • Milestone changed from 5.x to 5.0.1
  • Resolution set to fixed
  • Sprint FS demo 4.x deleted
  • Status changed from accepted to closed

Initial work done in previous milestones. Migrated to for future work.

Note: See TracTickets for help on using tickets. You may also have a look at Agilo extensions to the ticket.

1.3.13-PRO © 2008-2011 Agilo Software all rights reserved (this page was served in: 0.90596 sec.)

We're Hiring!