Skip to content

Conversation

antolinos
Copy link
Contributor

@antolinos antolinos commented Apr 30, 2025

This PR adds functionality to the ICATLIMS class to send messages to the logbook
So far, it's not particularly sophisticated, but it prints a table with the sample information each time synchronization occurs:
image

It also logs robot actions, although this still needs to be tested on the beamline.

This opens the door to register information that relevant from the experiment point of view (not from the software point of view)

Configuration

Few properties were added to the config:

  • logbook_enabled
  • elogbook_url
  • elogbook_token

Example drac.xml

<object class="ICATLIMS">
  <ws_root>https://icatplus.....</ws_root>
  <loginType>user</loginType>
  <object role="session" href="/session" />


  <download_sample_resources>true</download_sample_resources>

  <logbook_enabled>true</logbook_enabled>
  <elogbook_url>https://icatplus.esrf.fr</elogbook_url>
  <elogbook_token>elogbook-key-*****</elogbook_token>

  <queue_urls>...</queue_urls>
  <before_offset_days>20</before_offset_days>
  <after_offset_days>20</after_offset_days>
  <compatible_beamlines>ID23-1,ID30A-1,ID30B</compatible_beamlines>
  <!-- the list of sessions will be filtered by the override_beamline_name, this is needed when
  HWR.beamline.session.beamline_name does not match with the name of the instrument in the catalog -->
  <override_beamline_name>ID23-1</override_beamline_name>
  <download_processing_attachements>True</download_processing_attachements>
  <filter>participant</filter>
  <data_portal_url>https://data.......</data_portal_url>
  <logbook_url>https://data.....</logbook_url>
  <user_portal_url>https://smis.....</user_portal_url>
</object>

@antolinos antolinos linked an issue Apr 30, 2025 that may be closed by this pull request
@antolinos antolinos marked this pull request as draft May 9, 2025 09:09
@marcus-oscarsson
Copy link
Member

@antolinos, how it going with this one, are you sill working on this ?

@antolinos
Copy link
Contributor Author

Hi @marcus-oscarsson ,

I put this in stand-by until this is finished: #1260 (comment)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Add elogbook support
2 participants